[docs] Improve presentation style Python Docs

Jan j.geurtsen at gmail.com
Wed Aug 16 11:44:30 EDT 2017


Would it be possible to change the presentation style of the Python
documentation, so readability and discovery of information is improved
(especially for new users).
This could be achieved by using standardised sections for each module/class
page, making use of HTML tables to structure information (for example the
available functions), and better use of white space to aid overview and
discovery.

The documentation currently sometimes 'feels' like a big blob of text.
Pages can be perceived as long and unstructured, especially if you're a new
user who's not very familiar with the language yet.
https://docs.python.org/3/library/string.html

Example of C# documentation page
https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx
(just an example for inspiration purposes)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20170816/b3075359/attachment-0001.html>


More information about the docs mailing list