4c13ab8972
The notes were Chinese only, so a reader arriving from GitHub, which renders README.md by default, met a wall. Each note now follows the convention the wider ecosystem uses: English in X.md and Simplified Chinese in X.zh.md, with a switch at the top of both, the way zeromicro/go-zero and alist-org/alist present theirs. The Chinese text moved to the .zh.md name rather than being rewritten, so nothing was lost, and the English is a translation of the same content rather than a summary of it. Two figures in the notes had gone stale and are corrected while translating: there are thirteen expect assertions rather than twelve, because apsis-math/src/parallel.rs added one, and the table listed eight of them rather than all. The layer note no longer quotes an edge count, which changed as the code grew and was already out of date. |
||
|---|---|---|
| .. | ||
| README.md | ||
| README.zh.md | ||
| errors.md | ||
| errors.zh.md | ||
| layers.md | ||
| layers.zh.md | ||
| parallel.md | ||
| parallel.zh.md | ||
| sim.md | ||
| sim.zh.md | ||
| units.md | ||
| units.zh.md | ||
README.md
Design notes
English | 简体中文
This directory records the cross-crate design decisions of ApsisRS, such as the coordinate and unit conventions, the error and tolerance strategy, the layer boundaries and the parallelism. The design inside a single crate is documented in that crate's module documentation.
A note is self-contained and refers only to code in this repository or to a public standard.