v0.1.0-pre.070
This commit is contained in:
@@ -117,6 +117,7 @@ Les travaux planifiés pour supprimer une limite temporaire appartiennent au TOD
|
||||
Les exemples Rust doivent respecter les règles du workspace, y compris les conventions de propagation d’erreurs.
|
||||
|
||||
Chaque API publique significative doit disposer d’au moins un exemple ou être couverte par un exemple de scénario explicitement identifié. Les APIs triviales ou regroupées peuvent partager un exemple lorsqu’il démontre réellement leur usage.
|
||||
Un `USAGE.md` doit fournir plusieurs exemples lorsque la crate expose plusieurs familles d’API ou plusieurs étapes d’un parcours public. Un unique exemple global n’est suffisant que pour une surface publique réellement minimale. Les exemples doivent couvrir en priorité la construction des requêtes, leur validation, l’exécution principale, l’interprétation du résultat et les invariants opérateur pertinents.
|
||||
|
||||
### 4.4 Crates sans API bibliothèque publique
|
||||
|
||||
|
||||
5
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
5
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
@@ -27,7 +27,10 @@ Pour chaque API ou groupe cohérent :
|
||||
- valeur retournée ;
|
||||
- erreurs ;
|
||||
- invariants ;
|
||||
- exemple.
|
||||
- exemple de construction ou configuration ;
|
||||
- exemple de validation ;
|
||||
- exemple d’exécution ou d’appel principal ;
|
||||
- exemple d’interprétation du résultat lorsque pertinent.
|
||||
|
||||
## Types publics importants
|
||||
|
||||
|
||||
Reference in New Issue
Block a user