diff options
| author | Gervase Markham <gerv@gerv.net> | 2014-12-05 23:56:49 +0100 |
|---|---|---|
| committer | Gervase Markham <gerv@gerv.net> | 2014-12-05 23:56:49 +0100 |
| commit | 89bb14c9ef801f873caf8820927c1957b5f594cb (patch) | |
| tree | 2d3eb53b88060d32680f334f358015a360b7591c /docs/en/rst/style.rst | |
| parent | b6f9478220c5fae221143996e26c27ba97ecdaa9 (diff) | |
| download | bugzilla-89bb14c9ef801f873caf8820927c1957b5f594cb.tar.gz bugzilla-89bb14c9ef801f873caf8820927c1957b5f594cb.tar.xz | |
Bug 1107722 - Remove TODO markers in documentation. r,a=dkl.
Diffstat (limited to 'docs/en/rst/style.rst')
| -rw-r--r-- | docs/en/rst/style.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/en/rst/style.rst b/docs/en/rst/style.rst index aa3957b95..a1d6d7835 100644 --- a/docs/en/rst/style.rst +++ b/docs/en/rst/style.rst @@ -64,11 +64,13 @@ Other block types: .. warning:: This is a warning of a potential serious problem you should be aware of. -.. todo:: This is some documentation-related task that still needs doing. - Use both of the above block types sparingly. Consider putting the information in the main text, omitting it, or (if long) placing it in a subsidiary file. +.. todo:: This is some documentation-related task that still needs doing. + This is useful for short-term todos during development; however, + consider filing a bug for todos which will persist longer. + Code gets highlighted using Pygments. Choose the highlighter at the top of each file using: |