Skip to content

Commit ee6030d

Browse files
committed
DOCS: Move module descriptions from CONTRIBUTING table into module docs
The removed source layout table carried descriptions that existed nowhere in rustdoc: complex and traits had no module docs at all, and several first lines (Useful macros, Statistical Modules, Main structures) were too vague to serve as an index. Each module now carries its one-line purpose in its own mod.rs, so the docs.rs module index is the single source for the source map and stays in sync with the code by construction.
1 parent 737611c commit ee6030d

8 files changed

Lines changed: 12 additions & 8 deletions

File tree

src/complex/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Complex vectors, matrices, and integrals, enabled by the `complex` feature
2+
13
use num_complex::Complex;
24

35
pub type C64 = Complex<f64>;

src/macros/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Useful macros
1+
//! R / MATLAB / Julia style macros
22
33
pub mod julia_macro;
44
pub mod matlab_macro;

src/ml/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
//! Machine learning tools
1+
//! Basic machine learning tools (beta)
22
33
pub mod reg;

src/numerical/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Differential equations & Numerical Analysis tools
1+
//! Numerical algorithms: ODE solvers, quadrature, interpolation, splines, root finding, optimization, and eigenvalue computation
22
33
pub mod eigen;
44
pub mod integral;

src/statistics/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Statistical Modules
1+
//! Probability distributions, random sampling, and statistical operations
22
//!
33
//! * Basic statistical tools - `stat.rs`
44
//! * Popular distributions - `dist.rs` (`rand` feature)

src/structure/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
//! Main structures for peroxide
1+
//! Core data structures: `Matrix`, `Vec<f64>` extensions, `DataFrame`, `Polynomial`, and const-generic forward-mode AD (`Jet<N>`)
22
//!
3-
//! * Matrix
3+
//! * Matrix (dense & sparse)
44
//! * Vector
5-
//! * Automatic derivatives
5+
//! * Automatic differentiation (`Jet<N>`)
66
//! * Polynomial
77
//! * DataFrame
88
//! * Multinomial (not yet implemented)

src/traits/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Shared trait definitions: mathematics, functional programming, mutability, pointers, and numeric abstractions
2+
13
pub mod float;
24
pub mod fp;
35
pub mod general;

src/util/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Utility - plot, print, pickle and etc.
1+
//! Utilities: constructors, printing, plotting, and low-level helpers
22
33
pub mod api;
44
pub mod non_macro;

0 commit comments

Comments
 (0)