4.6 Minimal examples

A minimal example is an example which is as small as possible. These examples are much easier to understand than long examples. Minimal examples are used for

• Bug reports
• Sending a help request to mailists
• Adding an example to the LilyPond Snippet Repository

To construct an example which is as small as possible, the rule is quite simple: remove anything which is not necessary. When trying to remove unnecessary parts of a file, it is a very good idea to comment out lines instead of deleting them. That way, if you discover that you actually do need some lines, you can uncomment them, instead of typing them in from scratch.

There are two exceptions to the “as small as possible” rule:

• Include the \version number.
• If possible, use \paper{ ragged-right=##t } at the top of your example.

The whole point of a minimal example is to make it easy to read:

• Avoid using complicated notes, keys, or time signatures, unless you wish to demonstrate something is about the behavior of those items.
• Do not use \override commands unless that is the point of the example.

Other languages: French.