1.2 KiB
1.2 KiB
Modèle de guide d’utilisation de crate
Documenter uniquement la surface publique réellement accessible aux consommateurs.
Utilisation de <nom-de-crate>
Objectif
Prérequis
Dépendance et features
Configuration
Vue d’ensemble de l’API publique
APIs publiques significatives
Pour chaque API ou groupe cohérent :
- chemin public ;
- rôle ;
- paramètres ou types associés ;
- valeur retournée ;
- erreurs ;
- invariants ;
- exemple.
Types publics importants
Erreurs et invariants
Exemples
Utilisation du binaire
Supprimer cette section si aucun binaire public n’existe.
Contraintes et limites durables
Tests de référence
Lister uniquement les tests unitaires ou d’intégration qui constituent des exemples particulièrement instructifs de l’utilisation réelle de la crate, de ses invariants ou de ses parcours Devnet/Mainnet. Ne pas produire un catalogue exhaustif de tous les tests.
Références
Lier les autres exemples, fixtures et matrices canoniques sans les dupliquer.
Ne pas répéter ici une limite temporaire déjà planifiée dans
TODO.md. Les exemples Rust doivent respecter les règles du workspace.