Skip to content

Document the crate features #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChrisJr404 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

Document the crate features #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@

//! Rational numbers
//!
//! ## Features
//!
//! The `std` crate feature is enabled by default, which enables the [`std::error::Error`]
//! implementation for [`ParseRatioError`]. This can be disabled by depending on `num-rational`
//! with `default-features = false` for `no_std` support.
//!
//! ### Arbitrary Precision
//!
//! The `num-bigint` crate feature is enabled by default and provides the [`BigRational`] type
//! alias, a [`Ratio`] of arbitrary precision integers. Enable the `num-bigint-std` feature as
//! well to build `num-bigint` with `std` support.
//!
//! ### Serialization
//!
//! The `serde` feature adds implementations of `Serialize` and `Deserialize` for [`Ratio`]. A
//! value is serialized as a tuple of its numerator and denominator.
//!
//! ## Compatibility
//!
//! The `num-rational` crate is tested for rustc 1.60 and greater.
Expand Down