[Python-Dev] [Python-checkins] r84858 - in python/branches: py3k/Doc/library/logging.rst release27-maint/Doc/library/logging.rst (original) (raw)

Benjamin Peterson benjamin at python.org
Tue Sep 21 15:55:34 CEST 2010

2010/9/21 Nick Coghlan <ncoghlan at gmail.com>:

On Tue, Sep 21, 2010 at 5:25 PM, Georg Brandl <g.brandl at gmx.net> wrote:

I've been told that "Note that" should be removed altogether, as it's quite redundant :) I still find starting a paragraph with "Note that" to be useful as a mild attention getter that isn't as shouty as an actual ReST note.

I think the preference should be to avoid phases like "Note that". For example the sentence in consideration could be phrased nicely as "See :ref:custom-levels for documentation on defining your levels."

-- Regards, Benjamin

More information about the Python-Dev mailing list