launchpad-dev team mailing list archive

[Aaron Bentley <aaron@xxxxxxxxxxxxx>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Julian Edwards wrote:
> Precedent.  Pretty much most of our model objects already have this.  Our doc 
> strings are mostly awful and where they are not awful they are mediocre.

Our classes which implement interfaces have deliberately content-free
docstrings, and I really wish they didn't.  Having the documentation of
lp.code.model.Branch just saying "See `IBranch`." over and over is not
useful.

It is very useful to have the documentation and the implementation in
the same place, so that the documentation can serve as a guide to
understanding the implementation.  It also makes it easier to spot and
fix errors in the documentation.

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkuL3+YACgkQ0F+nu1YWqI2pvwCdEh7/Iw/f5cNz9Z8erbf8xUyW
mQwAmgL45pwQtqXvkb7TswHJRL7pZqtF
=pgos
-----END PGP SIGNATURE-----