Advertisement

Pro Python pp 207-215 | Cite as

Documentation

Abstract

Documentation is arguably the most difficult part of any project. Code tends to come fairly easy to programmers, but documentation requires a different set of skills because the audience is strictly human. The magnitude of the differences can vary greatly between projects and audiences. Sometimes all that’s necessary is some example code, while other topics can fill entire books and still have plenty left to cover.

Keywords

Automatic Documentation Naming Convention Entire Book Blank Line Link Target 
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.

Preview

Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.

Copyright information

© Marty Alchin 2010

Personalised recommendations