Merge pull request #8 from GeEom/docs-update

v2.0.1: Update docs.rs documentation

Author: GeEom

.github/workflows/auto-tag.yml

@@ -1,15 +1,15 @@
 [package]
 name = "fixed_analytics"
-version = "2.0.0"
+version = "2.0.1"
 edition = "2024"
 rust-version = "1.88"
 authors = ["David Gathercole"]
-description = "Fixed-point mathematical functions using the CORDIC algorithm"
+description = "Fixed-point mathematical functions. Accurate, deterministic, and panic free."
 repository = "https://github.com/GeEom/fixed_analytics"
 documentation = "https://docs.rs/fixed_analytics"
 readme = "README.md"
 license = "MIT"
-keywords = ["cordic", "fixed-point", "trigonometry", "math", "no_std"]
+keywords = ["fixed-point", "trigonometry", "math", "no_std", "deterministic"]
 categories = ["mathematics", "no-std", "algorithms", "embedded"]
 
 [package.metadata.docs.rs]

Cargo.toml

@@ -30,14 +30,14 @@ Requires Rust 1.88 or later.
 
 ```toml
 [dependencies]
-fixed_analytics = "2.0.0"
+fixed_analytics = "2.0.1"
 ```
 
 For `no_std` environments:
 
 ```toml
 [dependencies]
-fixed_analytics = { version = "2.0.0", default-features = false }
+fixed_analytics = { version = "2.0.1", default-features = false }
 ```
 
 ## Available Functions

README.md

@@ -1,4 +1,6 @@
-//! Fixed-point math via CORDIC. No floating-point ops, `no_std` compatible.
+//! Fixed-point mathematical functions: accurate, deterministic, and guaranteed not to panic.
+//!
+//! `no_std` compatible with no floating-point operations.
 //!
 //! # Quick Start
 //!
@@ -8,22 +10,45 @@
 //!
 //! let angle = I16F16::from_num(0.5);
 //! let (s, c) = (sin(angle), cos(angle));
+//!
 //! let root = sqrt(I16F16::from_num(2.0)).unwrap();
+//! assert!((root.to_num::<f32>() - 1.414).abs() < 0.001);
+//!
 //! let log = ln(I16F16::E).unwrap();
+//! assert!((log.to_num::<f32>() - 1.0).abs() < 0.01);
 //! ```
 //!
-//! # Precision
+//! # Available Functions
+//!
+//! **Total functions** return `T` directly, saturating on overflow.
+//! **Fallible functions** return [`Result<T, Error>`] on domain violations.
 //!
-//! | Type | Accuracy |
-//! |------|----------|
+//! | Category | Total | Fallible |
+//! |--------------|-------|----------|
+//! | Trigonometric | [`sin`], [`cos`], [`tan`], [`sin_cos`], [`atan`], [`atan2`] | [`asin`], [`acos`] |
+//! | Hyperbolic | [`sinh`], [`cosh`], [`tanh`], [`sinh_cosh`], [`asinh`] | [`acosh`], [`atanh`], [`acoth`], [`coth`] |
+//! | Exponential | [`exp`], [`pow2`] | [`ln`], [`log2`], [`log10`] |
+//! | Algebraic | — | [`sqrt`] |
+//!
+//! Functions use polynomial evaluation, CORDIC, and Newton-Raphson techniques.
+//! Complete absence of panic is verified at the linker level via the
+//! [`no-panic`](https://github.com/dtolnay/no-panic) crate.
+//!
+//! # Accuracy
+//!
+//! | Type | Typical Accuracy |
+//! |------|------------------|
 //! | `I16F16` | ~4 decimal digits |
 //! | `I32F32` | ~8 decimal digits |
 //!
+//! All functions are benchmarked against MPFR reference implementations.
+//! Accuracy regressions are not permitted across releases.
+//!
 //! # Features
 //!
-//! - `std` (default): Enables `std::error::Error` impl
+//! - **`std`** (default): Enables `std::error::Error` impl on [`Error`]
 //!
-//! See [`kernel`] module for algorithm details.
+//! See the [`kernel`] module for algorithm details.
 
 #![no_std]
 #![cfg_attr(docsrs, feature(doc_cfg))]