improving the Python docs -- a wiki? copy PHP's model?

Terry Reedy tjreedy at udel.edu
Wed May 5 11:06:31 EDT 2004


"Stephen Ferg" <steve at ferg.org> wrote in message
news:b16e4ef7.0405050516.4552c6c4 at posting.google.com...
> > Is submitting a bug or patch to sourceforge really that much of a
barrier?
>
> Yes, it is a significant barrier.  It requires knowledge of both Latex
> and a certain way of using diff.

Neither are required to submit a doc bug report, which can then be used by
someone else with the required knowledge to actually make the fix.  Typos
currently get fixed pretty quickly once reported.

A suggested sentence to replace an incorrect sentence may take longer to
get inserted.  But I have helped fix a few reported more-than-one-word-typo
doc glitches, without knowing either Latex or diff, by submitting comments
with a suggested sentence or two and with specific suggestion locations.

> In general, I'd agree that the Python documentation is outstanding.
> But there are gaps -- a qualifying phrase here, a missing reference
> there, a small example in many places.  Filling those gaps would make
> the difference in those places between documentation that is just
> barely adequate and documentation that is really excellent.

I admit I don't know whether 'text patches' would be as welcome for
enhancements as for fixes.  If I were inclined to submit such, I might
inquire first.

Terry J. Reedy







More information about the Python-list mailing list