This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author skip.montanaro
Recipients belopolsky, brian.curtin, catherine, skip.montanaro
Date 2010-08-26.21:27:06
SpamBayes Score 1.3477917e-07
Marked as misclassified No
Message-id <19574.56358.672541.527148@montanaro.dyndns.org>
In-reply-to <1282844890.06.0.732579415785.issue9650@psf.upfronthosting.co.za>
Content
Catherine,

Did my suggestion to alter pydoc output so it always contains a link to the
enclosing module's documentation not seem like a reasonable compromise?

Another problem with embedding the format codes in the docstring is that it
opens up a Pandora's box of other stuff that might be reasonable to include
in other docstrings, but should probably just be documented in one place
(perhaps with references elsewhere).  For example, maybe we should add the
list of signals to the docstrings for signal.signal and os.kill (pretty
platform-dependent) or add all the format possibilities to the docstring for
the format() builtin (brand new and probably not well-known to very many
users).  I'm sure there are other candidates.  It can be difficult to know
where to draw the line.

Skip
History
Date User Action Args
2010-08-26 21:27:08skip.montanarosetrecipients: + skip.montanaro, belopolsky, brian.curtin, catherine
2010-08-26 21:27:06skip.montanarolinkissue9650 messages
2010-08-26 21:27:06skip.montanarocreate