diff options
author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2013-06-06 09:13:12 +0000 |
---|---|---|
committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2013-06-06 09:13:12 +0000 |
commit | 75259abebd30ac06e7a785057169f5ae210616e6 (patch) | |
tree | 4154aea55b09a0e0000205b73ee0224fb501cec4 | |
parent | 00bacf1f9930f1b8ff198eeb50c110b142c309b2 (diff) | |
download | docutils-75259abebd30ac06e7a785057169f5ae210616e6.tar.gz |
Update "minimal example" hints.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@7670 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
-rw-r--r-- | BUGS.txt | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -57,21 +57,24 @@ create a `minimal example`_ that demonstrates the bug. The easier you make it to understand and track down the bug, the more likely a fix will be. +.. _minimal example: + .. sidebar:: minimal example - .. _minimal example: + A `minimal working example` is a complete example which is as as small and + simple as possible. It should be complete and working, so that - A minimal example is an example which is as small as possible. These - examples are much easier to understand than long examples. + * you cannot accidentally omit information important to diagnosing + the problem and + * the person responding can just copy-and-paste the code to try it out. - To construct an example which is as small as possible, the rule is - quite simple: *remove anything which is not necessary*. + To construct an example which is as small as possible, the rule + quite simple: *remove/leave out anything which is not necessary*. - See also: `LaTeX FAQ`__, `Lilypond Documentation`__, minimalbeispiel.de__ + See also: `What is a minimal working example?`__, `LaTeX FAQ`__ - __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl - __ http://lilypond.org/doc/v2.9/Documentation/user/lilypond/Minimal-examples __ http://www.minimalbeispiel.de/mini-en.html + __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl Now you're ready to write the bug report. Please include: |