BUGS.txt

   1 ================
   2  Docutils_ Bugs
   3 ================
   4
   5 :Author: David Goodger; open to all Docutils developers
   6 :Contact: goodger@python.org
   7 :Date: $Date$
   8 :Revision: $Revision$
   9 :Copyright: This document has been placed in the public domain.
  10
  11 .. _Docutils: http://docutils.sourceforge.net/
  12
  13
  14 Bugs in Docutils?!?  Yes, we do have a few.  Some are old-timers that
  15 tend to stay in the shadows and don't bother anybody.  Once in a while
  16 new bugs are born.  From time to time some bugs (new and old) crawl
  17 out into the light and must be dealt with.  Icky.
  18
  19 This document describes how to report a bug, and lists known bugs.
  20
  21 .. contents::
  22
  23
  24 How To Report A Bug
  25 ===================
  26
  27 If you think you've discovered a bug, please read through these
  28 guidelines before reporting it.
  29
  30 First, make sure it's a new bug:
  31
  32 * Please check the list of `known bugs`_ below and the `SourceForge
  33   Bug Tracker`_ to see if it has already been reported.
  34
  35 * Are you using the very latest version of Docutils?  The bug may have
  36   already been fixed.  Please get the latest version of Docutils from
  37   CVS_ or from the `development snapshot`_ and check again.  Even if
  38   your bug has not been fixed, others probably have, and you're better
  39   off with the most up-to-date code.
  40
  41   If you don't have time to check the latest snapshot, please report
  42   the bug anyway.  We'd rather tell you that it's already fixed than
  43   miss reports of unfixed bugs.
  44
  45 * If Docutils does not behave the way you expect, look in the
  46   documentation_ (don't forget the FAQ_!) and `mailing list archives`_
  47   for evidence that it should behave the way you expect.
  48
  49 If you're not sure, please ask on the
  50 docutils-users@lists.sourceforge.net [1]_ mailing list first.
  51
  52 If it's a new bug, the most important thing you can do is to write a
  53 simple description and a recipe that reproduces the bug.  Try to
  54 create a minimal document that demonstrates the bug.  The easier you
  55 make it to understand and track down the bug, the more likely a fix
  56 will be.
  57
  58 Now you're ready to write the bug report.  Please include:
  59
  60 * A clear description of the bug.  Describe how you expected Docutils
  61   to behave, and contrast that with how it actually behaved.  While
  62   the bug may seem obvious to you, it may not be so obvious to someone
  63   else, so it's best to avoid a guessing game.
  64
  65 * A complete description of the environment in which you reproduced
  66   the bug:
  67
  68   - Your operating system & version.
  69   - The version of Python (``python -V``).
  70   - The version of Docutils (use the "-V" option to most Docutils
  71     front-end tools).
  72   - Any private modifications you made to Docutils.
  73   - Anything else that could possibly be relevant.  Err on the side
  74     of too much information, rather than too little.
  75
  76 * A literal transcript of the *exact* command you ran, and the *exact*
  77   output.  Use the "--traceback" option to get a complete picture.
  78
  79 * The exact input and output files.  Better to attach complete files
  80   to your bug report than to include just a summary or excerpt.
  81
  82 * If you also want to include speculation as to the cause, and even a
  83   patch to fix the bug, that would be great!
  84
  85 The best place to send your bug report is to the `SourceForge Bug
  86 Tracker`_.  That way, it won't be misplaced or forgotten.  In fact, an
  87 open bug report on SourceForge is a constant irritant that begs to be
  88 squashed.
  89
  90 Thank you!
  91
  92 (This section was inspired by the `Subversion project's`__ BUGS__
  93 file.)
  94
  95 .. [1] Due to overwhelming amounts of spam, the
  96    docutils-users@lists.sourceforge.net mailing list has been set up
  97    for subscriber posting only.  Non-subscribers who post to
  98    docutils-users will receive a message with "Subject: Your message
  99    to Docutils-users awaits moderator approval".  Legitimate messages
 100    are accepted and posted as soon as possible (a list administrator
 101    must verify the message manually).  If you'd like to subscribe to
 102    docutils-users, please visit
 103    <http://lists.sourceforge.net/lists/listinfo/docutils-users>.
 104
 105 __ http://subversion.tigris.org/
 106 __ http://svn.collab.net/viewcvs/svn/trunk/BUGS?view=markup
 107
 108 .. _CVS: http://sourceforge.net/cvs/?group_id=38414
 109 .. _development snapshot: http://docutils.sf.net/#development-snapshot
 110 .. _documentation: docs/
 111 .. _FAQ: FAQ.html
 112 .. _mailing list archives: http://docutils.sf.net/#mailing-lists
 113 .. _SourceForge Bug Tracker:
 114    http://sourceforge.net/tracker/?group_id=38414&atid=422030
 115
 116
 117 Known Bugs
 118 ==========
 119
 120 Also see the `SourceForge Bug Tracker`_.
 121
 122 * .. _empty csv-table:
 123
 124   When supplying an empty file for the csv-table directive, Docutils
 125   crashes with a zero-division error.  Example::
 126
 127       .. csv-table::
 128          :file: empty.txt
 129
 130 * _`Line numbers` in system messages are inconsistent in the parser.
 131
 132   - In text inserted by the "include" directive, errors are often not
 133     reported with the correct "source" or "line" numbers.  Perhaps all
 134     Reporter calls need "source" and "line" keyword arguments.
 135     Elements' .line assignments should be checked.  (Assign to .source
 136     too?  Add a set_info method?  To what?)  There's a test in
 137     test/test_parsers/test_rst/test_directives/test_include.py.
 138
 139   - Some line numbers in elements are not being set properly
 140     (explicitly), just implicitly/automatically.  See rev. 1.74 of
 141     docutils/parsers/rst/states.py for an example of how to set.
 142
 143 * .. _none source:
 144
 145   Quite a few nodes are getting a "None" source attribute as well.  In
 146   particular, see the bodies of definition lists.
 147
 148 * .. _mislocated targets:
 149
 150   Explicit targets are sometimes mis-located.  In particular, placing
 151   a target before a section header puts the target at the end of the
 152   previous section instead of the start of the next section.  The code
 153   in docutils.transforms.misc.ClassAttribute could be used to fix
 154   this.  (Reported by David Priest.)
 155
 156 * David Abrahams pointed out that _`doubly-indirect substitutions`
 157   have a bug, but only when there's multiple references::
 158
 159       |substitute| my coke for gin
 160       |substitute| you for my mum
 161       at least I'll get my washing done
 162
 163       .. |substitute| replace:: |replace|
 164       .. |replace| replace:: swap
 165
 166   This is tricky.  Substitutions have to propagate back completely.
 167
 168 * .. _substitutions and references:
 169
 170   Another bug from David Abrahams (run with ``rst2html.py --traceback``)::
 171
 172       |substitution| and again a |substitution|.
 173
 174       .. |substitution| replace:: ref__
 175
 176       __ a.html
 177       __ b.html
 178
 179   Change the references.Substitutions tranform's priority from 220 to
 180   680, so it happens after reference resolution?  Then we have to deal
 181   with multiple IDs.  Perhaps the Substitution transform should remove
 182   all IDs from definitions after the first substitution reference is
 183   processed.
 184
 185 * Footnote label "5" should be "4"::
 186
 187       $ rst2pseudoxml.py <<EOF
 188       > ref [#abc]_ [#]_ [1]_ [#4]_
 189       >
 190       > .. [#abc] footnote
 191       > .. [#] two
 192       > .. [1] one
 193       > .. [#4] four
 194       > EOF
 195       <document source="<stdin>">
 196           <paragraph>
 197               ref
 198               <footnote_reference auto="1" id="id1" refid="abc">
 199                   2
 200
 201               <footnote_reference auto="1" id="id2" refid="id5">
 202                   3
 203
 204               <footnote_reference id="id3" refid="id6">
 205                   1
 206
 207               <footnote_reference auto="1" id="id4" refid="id7">
 208                   5
 209           <footnote auto="1" backrefs="id1" id="abc" name="abc">
 210               <label>
 211                   2
 212               <paragraph>
 213                   footnote
 214           <footnote auto="1" backrefs="id2" id="id5" name="3">
 215               <label>
 216                   3
 217               <paragraph>
 218                   two
 219           <footnote backrefs="id3" id="id6" name="1">
 220               <label>
 221                   1
 222               <paragraph>
 223                   one
 224           <footnote auto="1" backrefs="id4" id="id7" name="4">
 225               <label>
 226                   5
 227               <paragraph>
 228                   four
 229
 230 \f
 231 ..
 232    Local Variables:
 233    mode: indented-text
 234    indent-tabs-mode: nil
 235    sentence-end-double-space: t
 236    fill-column: 70
 237    End: