Daniel Ellis added the comment: Thank you Ezio, I will use that as a reference. What is the general workflow for updating documentation across python versions? Should I check to see if the documentation for the module changes across python versions and create patches for each version? Or is it sufficient to create a patch for one version?
On Wed, Aug 8, 2012 at 12:07 PM, Ezio Melotti <rep...@bugs.python.org>wrote: > > Ezio Melotti added the comment: > > Daniel, I would suggest you to start with a basic example that gives an > idea about how to use the module and its main functionalities. If > necessary you could add a section at the bottom with more examples. > You can also show how a method works with a short snippet (2-3 lines) just > after the documentation of the method, but this doesn't mean that every > method should have one. > If you have lot of examples you might consider doing a separate > tutorial/howto. > > As a reference see the examples in > http://docs.python.org/py3k/library/html.parser.html and > http://docs.python.org/py3k/library/unittest.html#basic-example. > > ---------- > > _______________________________________ > Python tracker <rep...@bugs.python.org> > <http://bugs.python.org/issue15586> > _______________________________________ > ---------- _______________________________________ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue15586> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
