Modèle:Documentation attendue/Documentation

Ceci est la page de documentation de Modèle:Documentation attendue [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Utilisation

Vous pouvez placer ce bandeau dans un modèle, à la fin de son code, entre les balises <noinclude>...</noinclude>, afin d’inciter les contributeurs à documenter les modèles adéquatement.

Syntaxe

{{Documentation attendue|description sommaire}}

Paramètres

1 = Description sommaire. (optionnel)
corps = valeur quelconque : Précise que la documentation est attendue dans le corps du modèle, et non en sous-page. Usage réservé à des applications spécifiques.

Exemples

{{Documentation attendue|description sommaire}}

La documentation explicative en sous-page de ce modèle est trop sommaire. Vous pouvez modifier ou créer cette sous-page afin de documenter ce modèle adéquatement.

{{Documentation attendue}}

Ce modèle ne possède aucune documentation explicative en sous-page, pas même une description succincte. Vous pouvez modifier ou créer cette sous-page afin de documenter ce modèle adéquatement.

{{Documentation attendue|corps=oui}}

Ce modèle ne possède aucune documentation explicative, pas même une description succincte. Vous pouvez modifier ce modèle en ajoutant un paramètre |contenu= afin de documenter ce modèle adéquatement.

Voir aussi

Comment documenter un modèle ?

Ce modèle « catégorise » la page qui l’emploie dans la catégorie Modèle sans documentation.