[issue19121] Documentation guidelines enhancements

2015-04-14 Thread Carol Willing
Changes by Carol Willing : -- stage: -> resolved ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.

[issue19121] Documentation guidelines enhancements

2015-04-14 Thread Carol Willing
Carol Willing added the comment: Thanks to all for the feedback. Since this issue covers a sufficiently broad set of thoughts, it would be better suited for a PEP. Closing this issue with the recommendation to submit a PEP if interested. -- nosy: +willingc resolution: -> not a bug sta

[issue19121] Documentation guidelines enhancements

2013-10-05 Thread CliffM
CliffM added the comment: Improving documentation is a fine aim. However, finding the correct balance between reference, tuition and precis (i.e. overview) is tricky. I would like to see more documentation laid out with the code and tests. This at least binds the examples with running code.

[issue19121] Documentation guidelines enhancements

2013-10-05 Thread Tshepang Lekhonkhobe
Changes by Tshepang Lekhonkhobe : -- nosy: +tshepang ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://ma

[issue19121] Documentation guidelines enhancements

2013-09-29 Thread Georg Brandl
Changes by Georg Brandl : -- nosy: +rhettinger ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.pyt

[issue19121] Documentation guidelines enhancements

2013-09-29 Thread anatoly techtonik
New submission from anatoly techtonik: I'll raise some points and then suggest how to fix that. issue19060 it appeared that list of functions that subprocess replaces imbues readers with uncertainty, because this list is not complete. Current http://docs.python.org/devguide/documenting.html gu