LWN.net Logo

Re: Best practice for documentation for std lib

From:  Guido van Rossum <guido-AT-python.org>
To:  Xavier Morel <python-dev-AT-masklinn.net>
Subject:  Re: Best practice for documentation for std lib
Date:  Sun, 22 Sep 2013 16:19:21 -0700
Message-ID:  <CAP7+vJLRn-HAhNwBGLOmdPZA7YBq5JCs=H19FVeard6Y8yqYNQ@mail.gmail.com>
Cc:  python-dev <python-dev-AT-python.org>
Archive-link:  Article, Thread

On Sun, Sep 22, 2013 at 2:41 PM, Xavier Morel <python-dev@masklinn.net>wrote:

> The points here are that there's a single source of truth (so we can't
> have conflicting docstring and rst documentation), and documentation
> becoming outdated can be noticed from both docstring and published
> documentation.
>

Another case of DRY madness.

It seems too many programmers see documentation as unpleasant red tape they
want to cut through as quickly as possible, instead of an opportunity to
communicate with their *users*. To the contrary: users should be the most
important people in the world if you're writing code that's worth
documenting at all.

-- 
--Guido van Rossum (python.org/~guido)


(Log in to post comments)

Copyright © 2013, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds