Re: epydoc reST markup for stdlib docstrings

Barry Warsaw <[email protected]>
Newsgroups gmane.comp.python.documentation
Organization Damn Crazy Followers of the Horn
Message-ID <20100413204047.4502b11e@heresy>
On Apr 14, 2010, at 01:30 AM, Michael Foord wrote:

>Definite +1 from me on adopting reST in docstrings as a standard. I 
>haven't looked at the Epydoc convention for parameters (etc) well enough 
>to have an opinion on that.

The thing I like about them is that the rules are very simple, and once
learned are easy to remember.

-Barry

_______________________________________________
Doc-SIG maillist  -  [email protected]
http://mail.python.org/mailman/listinfo/doc-sig
signature.asc (application/pgp-signature, 836 B)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)

iQIcBAEBCAAGBQJLxQ8PAAoJEBJutWOnSwa/TY8P/3V8DxXTndTV4PMv909SCcu4
H32r8P/KEPVg74ANy8454xgYClBdFj49inBXSj2drgsdq3tp1DCZtaTs020q2bBf
EkzWNP3FhAjc+m4rdXhBoHgquHOSydTR1kJvboxyVM7M4yITsGuOGt/vq4RMCbyz
DVncNDJf6y6iqR11Qbr+dieV5vuS+tFafBsxuN30hznvWX6s5R9WnhYCBUCCP/dS
EfAfklX1DJ5KmPMr6I+BzFTZ7gs0rQVIH3eZVcTY79Lrn3J8CJ3ArMg10x4oRLCt
6q2ON2ReZRDlBLdGRjeOYESVFmM1fQ22DQsOFtuMf/Ao839Z2cxxal+nzeqnCkVx
FhvJ7xwGLM+AWs8wy6tk5n5rYkqrFAlP6u9/8WEL8JqsfqV4jN14QwfbfOra/ltz
Kg1j7PGUuZAVuDgbhBedqHWqatALROUn/Yg2TWUTmGwOnPqKgbpX8Vb9gwhEdRdD
7LoIELvJkJN/4koEDjiu3McBNtSWyyh6d6sK+roO+PTejrup6soXk6kNWzeAQY4w
vhgV0sGh2W+gx/ncXzjv2RHiG7SjjhkBTegr/2vAo/qkI9DSKPWI8JeysViMeojV
cwtkPNDuRoXb/93xoZy5u2q+GReEzUbP1gdULeW5Y/Lr+8+DEV1zqhRyEaBXLaW1
oo1UqxyGaWq4szajY0V1
=/Hef
-----END PGP SIGNATURE-----
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.