[Python-Dev] status of development documentation

[Facundo Batista]

2005/12/21, Phillip J. Eby <pje at telecommunity.com>:

> 3. Fredrik believes that more people would participate in updating Python
> documentation if it didn't require a LaTeX toolchain or LaTeX-friendly editor.

I'm sure he's right. I'm not talking about any random user that finds
a doc bug and wants to generate a patch, here I'm talking of my own
experience:

I had to correct a few lines in the almost perfect documentation that
Raymond generated for Decimal. I fighted with my Linux (at that time,
FC1) to be able to compile the docs, and couldn't do it.

I ended touching the XML by hand. It worked, but

  a) Took some time.
  b) Wasn't really sure that it was well corrected.

So, I really think that a more human friendly format will help here.

What I do NOT know, if the effort of converting the whole docs to
another format is worth it, and that effort should be deviated to
something that will help more other users to help with docs (for
example, that the official docs could be annotatted, a la MySQL (AMK
did something like this, right?)).

Regards,

.    Facundo

Blog: http://www.taniquetil.com.ar/plog/
PyAr: http://www.python.org/ar/