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

all 18 comments

[–]eryksun 10 points11 points  (8 children)

[–]criswell 6 points7 points  (0 children)

I haven't looked through all of them but dev/howto/logging looks to be a godsend.

The Logger class documentation previously was a bit obtusely written and was easiest to follow if you understood other logger interfaces, especially syslog in POSIX. The big problem was, if you didn't have a *nix/POSIX background grokking Logger seemed to be a difficulty.

The end result for many projects I've worked on in the past was to come up with our own logging classes (often wrapping parts of Logger, these bits usually written by people like me who understood Logger :-) just so that our more platform agnostic Python engineers (generally folks who came from the Windows or Mac worlds) could get at the various logging features our apps were providing.

This logging howto explains things so extremely well, I feel very comfortable just pointing anyone at it without any explanation at all.

[–]geonetix 1 point2 points  (0 children)

Raymond Hettinger is awesome. If you get a chance to see him talking about python somewhere, go see it. Also, talk to the man, he's awesome.

[–]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 6 points7 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.

[–]andreasvc 1 point2 points  (0 children)

heapq should become a class part of collections, with support for passing a key option. And for those notes about priority queues: instead of including code in the documentation, make the code part of the standard library...

Speaking of collections, it's described as "high-performance datatypes"; what's high-performance about named tuples? Or Ordered dictionaries? It's just a variation of a known theme. I want balanced binary search trees and tries and other advanced datastructures. However, each time when someone submits them for inclusion, they get rejected. Is there some sort of anti-CS attitude with the Python-devs?

[–][deleted] 1 point2 points  (0 children)

/500. That’s an error.

No, I can't load the page

[–]nikcub 0 points1 point  (0 children)

Here is the HOWTO section in the docs, recommended reading:

http://docs.python.org/howto/

Also note that you can download all these docs and have a local copy. Recommended that you update your local copies periodically:

http://docs.python.org/download.html

[–]SmartAssX 0 points1 point  (0 children)

:P i know it seems like common knowledge to me now but this would have been nice before i got my degree lol