diff options
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: |