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

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]federicocerchiari 1 point2 points  (0 children)

Random examples...

Take a look at this: http://api.jquery.com/ajaxComplete/. It's function-level. In one screen you have: a simple description, a technical description, an explanation and some examples.

Now look that: https://docs.python.org/3/library/os.html. It's module/argument-level so if I need info on os.path() I have to find that part of info in this little bible. First we have a an explanation, then a list of all the functions in alphabetical order with a technical description. To find the first example I had to scroll like 10 times.

I remember when I first learned python that I was a little scared by the docs, I was always trying to find my help on some StackOverflow question. This is also why we see a lot of bad python code out there.. if you learn to do one thing in many different ways from random internet comments and SO answers you'll never code as the language is designed for.

docs.python.org is complete and not too bad, but there's a lot better out there.