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.

Tests de référence

Documenter les tests unitaires particulièrement instructifs qui démontrent un contrat public, un invariant, un format canonique ou une non-régression.

Limites connues

Références

Lier les tests, exemples, fixtures et matrices canoniques sans les dupliquer.

1005 B Raw Blame History Unescape Escape