Re: epydoc reST markup for stdlib docstrings
Fred Drake <[email protected]>
| Newsgroups | gmane.comp.python.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Wed, Apr 14, 2010 at 10:39 AM, Michael Foord <[email protected]> wrote: > Right - and included in the contract can be details like what exceptions an > API raises. We don't necessarily need a standard to specify that (?) but it > is the sort of information that ought to be in docstrings where relevant. Yep. I was really just wanting to emphasize that extracting information from the signature is likely to be wrong. Unless there's a way to say explicitly that it's right. (Which would require a known interpretation, which isn't really as easy as it sounds.) -Fred -- Fred L. Drake, Jr. <fdrake at gmail.com> "Chaos is the score upon which reality is written." --Henry Miller _______________________________________________ Doc-SIG maillist - [email protected] http://mail.python.org/mailman/listinfo/doc-sig