Chapter 9. Documentation


"Real programmers don't comment their code. If it was hard to write, it should be hard to understand.

Real Programmers don't do documentation. Documentation is for those who can't figure out the listing."


The days of the hero coder toiling away in the darkness for 36 hours straight to produce the perfect code are drawing to a close. Although that still happens (and is fun to do), at the end of the day, most code is written for other people to use, fix, and extend. In order to do this, people other than the original author need to be able to understand what the code does and how.

These groups fall into three classes, each with its appropriate genre of documentation:




User manuals and sales ...

Get Mastering IPython 4.0 now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.