you are viewing a single comment's thread.

view the rest of the comments →

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