Skip to main content

Documentation

  • Chapter
  • First Online:
Pro Python Best Practices
  • 6747 Accesses

Abstract

When my parents refurbished the wooden panels on the house in the 1980s, my mother deposited a newspaper in between the wall and the new panels. When I wondered what my mom was doing, she explained: “This is our message into the future. Whoever will be the next to replace the panels, will find the newspaper and see how we saw the world today.” Someone else, maybe a few decades later, would catch a glimpse of our life when the paneling was built (for instance that newspapers were considered to give testimony of history). Looking into the past is difficult. Of course, it is easier than looking into the future. There is some information: we can see the old, wooden panels, in their probably withered state. We can see what has been built, but not what our state of mind was, our hopes, our reasons, our intentions. Documenting software is similar.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

eBook
USD 19.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 29.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Author information

Authors and Affiliations

Authors

Rights and permissions

Reprints and permissions

Copyright information

© 2017 Kristian Rother

About this chapter

Cite this chapter

Rother, K. (2017). Documentation. In: Pro Python Best Practices. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-2241-6_17

Download citation

Publish with us

Policies and ethics