Create textual documentation of various modules
-----------------------------------------------
Key: QPID-519
URL: https://issues.apache.org/jira/browse/QPID-519
Project: Qpid
Issue Type: Improvement
Components: Python Client
Reporter: Jimmy John
Priority: Minor
Attachments: codec.txt, xmlutil.txt
We need to create textual descriptions of what the various modules are doing.
This will allow people to just read such documentation to gain an understanding
of what the modules are doing rather than having to dig through code to figure
things out. To see a practical example of this go to
http://code.djangoproject.com/browser/django/trunk/docs
Here the documentation is arranged in the form of txt files for each module, so
first time users can just browse though it.
Such documentation needs to be placed in the doc folder, so it is available
with the python download.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
