Skip to content

Document features #71

Open
Open

Description

@maxbla

This crate makes use of features so that "you don't pay for what you don't use" and to support no_std while allowing for extensions that require the standard library. This is good, but it can be beginner unfriendly. The readme should include a brief overview of the features this crate provides with a beginner friendly presentation.

Activity

  1. cuviper commented on Mar 13, 2020

    @cuviper
    Member

    Sure, would you like to write that up? The current features are:

    • std enables the full standard library (on by default)
    • bigint-std enables BigRational using std (on by default)
    • bigint enables BigRational using just core and alloc (requires Rust 1.36+)
    • serde implements Deserialize and Serialize for Ratio<T>

    Technically, cargo will accept num-bigint as a feature here too for the optional dependency, but it doesn't actually enable anything in num-rational. I'm now thinking we should simplify that one -- package renaming can let us have just bigint and our added bigint-std, or we can go the other way to full num-bigint and add explicit num-bigint-std instead. Thoughts?

  2. cuviper commented on Aug 28, 2021

    @cuviper
    Member

    Sure, a PR to improve docs would be welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions