[Python-Dev] Unit testing (again)

Moshe Zadka moshez@zadka.site.co.il
Wed, 14 Feb 2001 18:47:17 +0200 (IST)


On Tue, 13 Feb 2001 16:45:56 -0500, Guido van Rossum <guido@digicool.com> wrote:

> Of course, this is means that *if* you use doctest, all authoritative
> docs should be in the docstring, and not elsewhere.  Which brings us
> back to the eternal question of how to indicate mark-up in
> docstrings.  Is everything connected to everything?

No, but a lot of things are connected to documentation.
As someone who works primarily in Perl nowadays, and hates it, I must say
that as horrible and unaesthetic pod is, having

perldoc package::module

Just work is worth everything -- I've marked everything I wrote that way,
and I can't begin to explain how much it helps. I'm slowly starting to
think that the big problem with Python documentation is that you
didn't pronounce. So, if some publisher needs to work harder to make
dead-trees copies, it's fine by me, and even if the output looks a bit
less "professional" it's also fine by me, as long as documentation is
always in the same format, and always accessible by the same command.

Consider this an offer to help to port (manually, if needs be) Python's
current documentation.

We had a DevDay, we have a sig, we have a PEP. None of this seems to help --
what we need is a BDFL's pronouncement, even if it's on the worst solution
possibly imaginable.
-- 
For public key: finger moshez@debian.org | gpg --import
"Debian -- What your mother would use if it was 20 times easier"
LUKE: Is Perl better than Python?
YODA: No... no... no.  Quicker, easier, more seductive.