Skip to content

Commit

Permalink
Improving feature flags info
Browse files Browse the repository at this point in the history
  • Loading branch information
coreylowman committed Oct 27, 2022
1 parent c60fcaf commit d4796d8
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions src/feature_flags.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
//! Information about the available feature flags
//! Information about the available feature flags.
//!
//! # "std" **Default flag**
//! Default features:
//! - "std"
//! - "numpy"
//!
//! # "std"
//!
//! **Enabled by default**
//!
//! Enables usage of the standard library. Otherwise [no_std_compat](https://crates.io/crates/no-std-compat)
//! is used.
//!
//! Example:
//! ```toml
//! dfdx = { version = "...", default-features = false }
//! ```
//!
//! Note that allocations are necessary, so the no_std_compat dependency looks like:
//! ```toml
//! no-std-compat = { version = "0.4.1", features = [ "alloc", "compat_hash" ] }
Expand Down Expand Up @@ -34,7 +45,9 @@
//!
//! `build.rs` will fail helpfully if you don't have the correct path/environment variables.
//!
//! # "numpy" **Default flag**
//! # "numpy"
//!
//! **Enabled by default**
//!
//! Enables saving and loading arrays to .npy files, and saving and loading nn to .npz files.
//!
Expand Down

0 comments on commit d4796d8

Please sign in to comment.