[Doc-SIG] formalizing StructuredText

Edward Welbourne Edward Welbourne <eddy@chaos.org.uk>
Sat, 24 Mar 2001 16:39:02 +0000 (GMT)


>> Are we expecting people to *want* to link into a document from
>> outside?  I can't see ever having any use for that when writing
>> API docs...
> 
> I don't have a use for it, myself, directly.

erm.  The documentation of class Foo overrides a method of Foo's base,
explains the difference in Foo's version's docstring, but needs to refer
to the bit of the base's implementation in which is explained the
hideous and hairy reason why certain bits have to behave the way they
do.  The base's implementation's docstring gave that portion a named
anchor to which derived classes' docstrings could refer.

	Eddy.