[PYTHONMAC-SIG] Pod

[Tom Fetherston]

Hi All,

Is anyone familiar with the way perl code is being documented via .pod
(plain old documentation)?

Seems to me that this is a natural thing for python to adopt.

POD documents are just like super simple html files and have translators
for make real html, man, and latex files out of them.  The way paython
supports multi-line strings for use as code/routine comments should
integrate well with pod.

Should be easily usable by a smalltalk like set of code browsers, or a
standalone code inspector like the MacPerl "shuck" app (which lets you
format according to pod's tags, and toggle code/code&pod/pod visiblity)
should be fairly easy to do in python.

Such an approach would put you ahead in the documenting game.

Any thought on this?

Tom



_______________
PYTHONMAC-SIG  - SIG on Python for the Apple Macintosh

send messages to: pythonmac-sig@python.org
administrivia to: pythonmac-sig-request@python.org
_______________