Skip to content

Commit 737611c

Browse files
committed
DOCS: Replace source layout table with pointer to docs.rs module index (JOSS jonaspleyer #99)
The hand-maintained module table duplicated the module index that rustdoc generates on docs.rs and could only drift out of sync. What remains is the repo-only fact rustdoc cannot show: src/grave/ is retired code excluded from compilation.
1 parent 23e5930 commit 737611c

1 file changed

Lines changed: 2 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,8 @@ Peroxide follows the [Gitflow workflow]. A few practical rules:
4141

4242
## Source layout
4343

44-
A high-level map of `src/`; see each module's `mod.rs` and the [API docs](https://docs.rs/peroxide) for details.
45-
46-
| Module | Purpose |
47-
| ------------------ | ------------------------------------------------------------------ |
48-
| [`structure`](src/structure) | Core data structures: `Matrix`, `Vec<f64>` extensions, `DataFrame`, `Polynomial`, `Jet<N>` forward AD |
49-
| [`numerical`](src/numerical) | Numerical algorithms: ODE solvers, integration, interpolation, splines, root finding, optimization, eigenvalues |
50-
| [`statistics`](src/statistics) | Probability distributions, RNG wrappers, ordered statistics |
51-
| [`complex`](src/complex) | Complex vectors, matrices, and integrals (`complex` feature) |
52-
| [`special`](src/special) | Special functions (wrapper of `puruspe`) |
53-
| [`traits`](src/traits) | Shared trait definitions (math, functional programming, pointers) |
54-
| [`macros`](src/macros) | R / MATLAB / Julia style macros |
55-
| [`fuga`](src/fuga), [`prelude`](src/prelude) | The two user-facing import styles (explicit vs simple) |
56-
| [`util`](src/util) | Constructors, printing, plotting, low-level helpers |
57-
| [`ml`](src/ml) | Basic machine learning tools (beta) |
58-
| [`grave`](src/grave) | Retired implementations kept for reference; not compiled |
44+
The directories under `src/` map one-to-one to the public modules, so the module index in the [API docs](https://docs.rs/peroxide) doubles as the source map; start from a module's documentation and its `mod.rs`.
45+
The only exception is `src/grave/`, which holds retired implementations kept for reference and is excluded from compilation.
5946

6047
## Code of conduct
6148

0 commit comments

Comments
 (0)