5.2.3 Exemples minimalistes
Un exemple minimal est un exemple de code aussi court que possible. De tels exemples sont bien plus compréhensibles que des exemples longs. Les exemples minimaux sont utilisés pour
- les rapports de bogue,
- les demandes d’aide sur les listes de diffusion,
- un ajout à LilyPond Snippet Repository.
Pour construire un exemple minimal, la règle est très simple : enlevez tout ce qui n’est pas nécessaire. Il est préférable de commenter les lignes non nécessaires plutôt que de les effacer : ainsi, si vous vous apercevez que certaines étaient réellement nécessaires, vous pouvez les décommenter au lieu de les resaisir.
Il y a deux exceptions à cette règle du strict nécessaire :
- incluez le numéro de
\version
en début de fichier - si possible, utilisez
\paper{ ragged-right=##t }
au début de votre exemple.
Tout l’intérêt d’un exemple minimal réside dans sa facilité de lecture :
- évitez d’utiliser des notes, armures ou métriques compliquées, à moins que vous ne vouliez montrer quelque chose en rapport avec celles-ci,
- n’utilisez pas de commandes
\override
sauf si elles font l’intérêt de l’exemple.