Then, let it be epydocs (thanks ra3don). Let's get concensus on a good
template for a man-page docstring and get on with it!

I'm going to suggest that major headings include:

Name of command
Synopsys
Description
Parameters and their meanings
Return values
Examples
Links (to external documentation)
Comments

I just now looked at the php documentation and it covers all the
above. Indeed, it looks really useful and is well organized.

Reply via email to