Skip to content

Commit e9472fd

Browse files
docs: fix crate-level doc inaccuracies
- '44 additional' → '110 additional' constants - '14 macros' → '15 macros (7 no_std + 8 std)' throughout - Feature Flags table: added datetime, ConstantValue, 8 std macros - Modules section: added Category filtering, macro list, WASM mention
1 parent f8164ff commit e9472fd

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

src/lib.rs

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,23 @@
1212
//! ## Why CMN?
1313
//!
1414
//! `std::f64::consts` provides 11 mathematical constants. CMN
15-
//! extends that with 44 physical, cryptographic, and series
16-
//! constants — plus a runtime lookup API, 14 utility macros,
17-
//! and a built-in word-list module. Every constant resolves at
18-
//! compile time. Works in `no_std` environments.
15+
//! extends that with 110 additional physical, cryptographic,
16+
//! and series constants — plus a runtime lookup API, 15
17+
//! utility macros (7 `no_std` + 8 `std`), a datetime module,
18+
//! and a built-in word-list. Every constant resolves at
19+
//! compile time. Works in `no_std` and WASM environments.
1920
//!
2021
//! ## Modules
2122
//!
2223
//! - **[`constants`]** — 121 `const` values (PI, Avogadro,
23-
//! Planck, etc.). With `std`: runtime `Constants` lookup API
24-
//! + `ConstantValue` typed enum.
25-
//! - **[`macros`]** — 14 utility macros for min/max,
26-
//! range-checks, collections, and parsing.
24+
//! Planck, W/Z/Higgs boson, etc.) with `Category` filtering.
25+
//! With `std`: runtime `Constants` lookup API +
26+
//! `ConstantValue` typed enum.
27+
//! - **[`macros`]** — 15 utility macros: 7 `no_std`
28+
//! (`cmn_max!`, `cmn_min!`, `cmn_in_range!`, `cmn_assert!`,
29+
//! `cmn_contains!`, `cmn_to_num!`, `cmn_constants!`) + 8
30+
//! `std` (`cmn_vec!`, `cmn_map!`, `cmn_join!`, `cmn_split!`,
31+
//! `cmn_print!`, `cmn_print_vec!`, `cmn!`, `cmn_parse!`).
2732
//! - With `std` feature: **[`words`]** module, **[`datetime`]**
2833
//! utilities, and **`Common`** JSON bridge.
2934
//!
@@ -56,7 +61,7 @@
5661
//!
5762
//! | Feature | Default | Enables |
5863
//! |---------|---------|---------|
59-
//! | `std` | Yes | `Constants` struct, `Words`, `Common`, serde support |
64+
//! | `std` | Yes | `Constants` struct, `ConstantValue`, `Words`, `Common`, `datetime`, 8 std macros, serde |
6065
//!
6166
//! For `no_std`, disable default features:
6267
//! ```toml
@@ -81,8 +86,8 @@
8186
#[cfg(feature = "std")]
8287
use serde::{Deserialize, Serialize};
8388

84-
/// 14 utility macros for assertions, collections, range-checks,
85-
/// and string operations. Available in `no_std`.
89+
/// 15 utility macros: 7 `no_std`-compatible + 8 `std`-only.
90+
/// See the [`macros`] module for the full list.
8691
pub mod macros;
8792

8893
/// 121 mathematical, physical, and cryptographic constants as

0 commit comments

Comments
 (0)