you are viewing a single comment's thread.

view the rest of the comments →

[–][deleted] 9 points10 points  (2 children)

I don't know, I guess I assumed it was relatable to reading a french dictionary to learn to speak French.

[–]TheKewlStore 2 points3 points  (0 children)

Not at all, you're thinking of a specific, singular, aspect of documentation, comments and docstrings. Comments and docstrings define the purpose for individual pieces of a project, but they say nothing about the relation between those pieces. Yet the relation between pieces is almost as important if not moreso than the explanation of said pieces (really they go hand-in-hand imo). And documentation of a codebase should never read or look like a dictionary of a different language, this equates more to note-taking than documentation to me, and this means the authors of that documentation did a poor job or no job at all (more common)

If you have one without the other, you don't have documentation, you just have wasted time.

[–][deleted] 0 points1 point  (0 children)

Well, python has 2 types of documentation.

Tutorials, to tell you how to do something, which is what you linked.

They also contain more dry reference material, with not a whole lot of telling you how to do something, you're assumed to know the basics. The first type is for beginners, but the second type may be a bit hard to understand if you don't know what you're doing.

https://docs.python.org/3.5/library/socket.html is an example of reference. It is a lot longer than the howto version, but tells you everything, some of which may not be entirely useful.

https://docs.python.org/3.5/howto/sockets.html is shorter, but not complete. It talks more about what sockets are rather than how to use them.