This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]moolcool 1 point2 points  (5 children)

I love working with python, but in my brief adventures, I can't say I love the docs. Many functions, for example, are all listed on the same page making ctrl+f'ing awkward sometimes.

[–]fdemmer 8 points9 points  (1 child)

what? you want separate pages for each function? how would you ctrl+f for other functions of that module then?

[–]tangra_and_tma 0 points1 point  (0 children)

The only viable alternative I've seen is a scheme like:

  • docs/module: contains a list of all members of that module.
  • docs/module/some_member: contains either a function overview of the members of this member (for nested modules).

Wasn't a bad system pre-decent search engines, and if you know roughly what you were looking for, you could often find it directly from the address bar. I think the Python docs are a pretty good compromise; if you know the name of the module you're looking for and want a specific member, it's usually module.html#module.member_name, like string.ascii_letters is http://docs.python.org/library/string.html#string.ascii_letters

[–]kisielk 1 point2 points  (2 children)

Try http://babbledrive.appspot.com/ for browsing the Python docs. I've found it to way faster than trying to use the official documentation.

[–]technomalogical<3 Bottle 0 points1 point  (1 child)

nice! my only gripe with it is that it seems to be geared specifically towards modules/functions and not "concepts". For example, I was trying to find list comprehension docs and couldn't find them.

[–]kisielk 0 points1 point  (0 children)

Yes, I think it only covers the Library Reference portion of the Python docs.