Do you feel bad because of the Python docs?
Rick Johnson
rantingrickjohnson at gmail.com
Wed Mar 6 21:41:02 EST 2013
On Wednesday, March 6, 2013 7:52:59 PM UTC-6, Terry Reedy wrote:
> > How much longer are we going to "treat the symptoms"
>
> We would VERY MUCH like a system to make it easier for readers to report
> doc bugs and developers to fix them. No one yet has come up with both a
> reasonable idea and workable implementation. Here is an idea I just came
> up with.
>
> *Someone* writes javascript that allows the following: Reader using the
> web version sees a mistake, selects some text with the mistake, right
> clicks, selects 'Suggest correction', gets a box or form with the
> selected text, page and location or context info, and a text entry box.
> Reader enters correction in text box and clicks OK. Message is emailed
> or posted to python.org.
YES, YES, YES! This is even better than "PyWarts" because the user will not need to log onto a forum and then compose a post. In effect, the forum will come to him! I love it!
However, there is a dark-side on the opposite side of this mountain. Your idea solves "doc related" issues, but what about "language related" issues? I still love your idea, however, i am looking for a holistic approach to solving the issue.
> *Someone* writes a python script to process reports by generating a
> proposed patch for human review.
Also, i would like to add. That all user submitted "reports" should be posted in a searchable database somewhere that is public; so we can keep track of which parts of the docs (or language) are creating the highest volume of complaints\bugs.
More information about the Python-list
mailing list