[Doc-SIG] Re: docstrings for re.py?

Edward Welbourne Edward Welbourne <eddyw@lsl.co.uk>
Mon, 12 Jul 1999 11:51:12 +0100


GvR:
> additional documentation ... __flags_doc__ ... tools won't know to
> look there.
JC:
> Yes, I'm torn about this.

The automatic tools will document various things if it finds them in the
namespace of the module ... can't remember the complete list ... if
you're very lucky, a string called re.__flags_doc__ (or, indeed,
re.flags_doc) will show up naturally in the documentation: otherwise,
consider introducing a spurious entity which exists to carry this doc

class Flags:
    """dummy class as place-holder for re flags documentation ..."""

or similar ...

just a suggestion,

	Eddy.