Opened 12 years ago
#34 new
Consider using python docstring functionality to replace pdf doc
Reported by: | sedwards@bbn.com | Owned by: | somebody |
---|---|---|---|
Priority: | major | Milestone: | |
Component: | Clients | Version: | |
Keywords: | Cc: | ||
Dependencies: |
Description
It occurs to me that we could probably use the python docstring functionality (the thing in triple quotes) to replace the pdf doc, by including the relevant information for each object in the docstring comment. I found this relevant PEP on formatting docstrings which leads me to believe it is the appropriate place to document options, etc. Just a thought. Don't have to deal with that right now. Don't have to do it at all if you don't want.
Note: See
TracTickets for help on using
tickets.