From 89bb14c9ef801f873caf8820927c1957b5f594cb Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Fri, 5 Dec 2014 14:56:49 -0800 Subject: Bug 1107722 - Remove TODO markers in documentation. r,a=dkl. --- docs/en/rst/style.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/en/rst/style.rst') 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: -- cgit v1.2.3-24-g4f1b