[Doc-SIG] More documentation
Manuel Gutierrez Algaba
Manuel Gutierrez Algaba <irmina@ctv.es>
Mon, 7 Feb 2000 20:53:34 +0000 (GMT)
On Sun, 6 Feb 2000, Jack Jansen wrote:
>
> At least, in my mind the examples are all far too verbose: lots of
> formatting info, typing info on the variables/functions/exceptions
> used, etc.
Common sense.
>
> I know that for me this will not work. Not only do I abhor weave-like
> systems (I think writing real documentation should be done with a
> completely different mindset,
Common sense, but sometimes weave-like may work, it depends on
the programm.
> and not sort-of in-between while writing
> the code) but I'm also sure to forget the syntax, so after staring at
> the opening """ for a few seconds I'll think "ah, forget it. Who needs
> docs anyway".
Common sense
> The scheme we seemed to be converging to before the conference was
> much more to my liking: basically free-format with a few readable
> flag-words like "arguments:" or so.
Common sense
Regards/Saludos
Manolo
www.ctv.es/USERS/irmina /TeEncontreX.html /texpython.htm
/pyttex.htm
I just got out of the hospital after a speed reading accident. I hit a bookmark. -- Steven Wright