docs: add coverage reference files and flag architectural drift

These files catalog test coverage for Rust modules across architecture, implementation, and theory sections. They track recent structural changes, flag areas prone to documentation drift, and mandate verification of key parameters and routing logic to maintain alignment with the active codebase.
This commit is contained in:
Eric Coissac
2026-05-23 13:19:31 +02:00
parent b2a52bfb37
commit b7db3a33ed
22 changed files with 335 additions and 0 deletions
+11
View File
@@ -0,0 +1,11 @@
<!-- coverage sidecar — ne pas ajouter au nav mkdocs -->
# Coverage: theory/encoding.md
## Code couvert
- `obikseq/src/kmer.rs` — encodage 2 bits/base, revcomp, forme canonique
## Notes
Document purement théorique. Peu de risque de dérive sauf si l'encodage interne de Kmer change.
Vérifier que la table d'encodage A=00, C=01, G=10, T=11 est toujours celle du code.
+12
View File
@@ -0,0 +1,12 @@
<!-- coverage sidecar — ne pas ajouter au nav mkdocs -->
# Coverage: theory/entropy.md
## Code couvert
- `obiskbuilder/src/entropy_table.rs` — filtre Shannon sur les kmers à basse complexité
- `obiskbuilder/src/lib.rs` — application du filtre lors du scatter (phase 1)
## Notes
Document théorique stable. Vérifier que les paramètres `theta` et `level_max` dans le CLI
(`obikmer/src/cli.rs``CommonArgs`) correspondent bien à ce qui est décrit.
+12
View File
@@ -0,0 +1,12 @@
<!-- coverage sidecar — ne pas ajouter au nav mkdocs -->
# Coverage: theory/indexing.md
## Code couvert
- `obikpartitionner/src/partition.rs` — routage par hash de minimiseur, choix des paramètres
- `obikpartitionner/src/lib.rs` — structure KmerPartition, nombre de partitions
## Notes
Vérifier que la doc mentionne bien que le nombre de partitions est une puissance de 2
(converti par `partitions_to_bits` dans `obikmer/src/cli.rs`).
+12
View File
@@ -0,0 +1,12 @@
<!-- coverage sidecar — ne pas ajouter au nav mkdocs -->
# Coverage: theory/minimizer.md
## Code couvert
- `obiskbuilder/src/lib.rs` — sélection du minimiseur par hash seedé (splitmix64 finalizer)
- `obikseq/src/superkmer.rs` — forme canonique du minimiseur, fenêtre glissante
## Notes
Vérifier que la fonction de hash décrite (splitmix64 finalizer avec graine) correspond
au code actuel. Vérifier aussi que la définition de « minimiseur canonique » est toujours cohérente.