[docs] how about adding anchor tags to the functions
guanfenglin at gmail.com
Sun Nov 13 19:20:44 CET 2011
First of all, hands down to the effort for the detailed Python
I was a long time PHP programmer and enjoyed the PHP documentation style,
single page of specific function documentation and samples, then community
contribution. While I agree Python is different to PHP, but I think the
Python ducmentation still has room to improve and the community should
still be able to "borrow" some goodies from the PHP documentation style.
Perhaps I may not be the first one who suggested this, but I do find having
the anchor tags on the function names(so google can index and provide
directly to the specific section) in the doucmentation really reduce some
frustration on reading the python documentation.
eg. if I am searching "python urllib urlretrieve" and google results page
shows the relevant information but with this link here
http://docs.python.org/library/urllib.html, then I am required to do
another page search to locate the information i want, it would be great
that if the site provides links like
http://docs.python.org/library/urllib.html#urllib.urlretrieve, so the
browser automatically scrolls to the right section? Also, it would be
awesome to have some code examples of each function, if that's too much
effort needed, how about having a collapsed community section(similar to
PHP) under each function?
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the docs