I believe that a commenting system could be very helpful.<br>I have done some PHP coding and in my early years the chm that includes the comments was of great value to me since I never had an Internet connection at home so I would just download the document from a cyber cafe and hack away.<br>
In the case of Python, where I still don't have a lot of experience, the fact that I must always be online to find possible solutions to a problem can be quite a drag, still, dir and docstrings help a lot though.<br>At that if I could help out, Georg, let me know how, I'm relatively new to this stuff but I would love to give back to the community, Python has made me quite some money.<br>
<br>Kind Regards,<br>Patrick Atambo.<br><br>On 11/21/08, Brett Cannon <<a href="mailto:brett@python.org">brett@python.org</a>> wrote:<br>> On Fri, Nov 21, 2008 at 05:49, Ezio Melotti <<a href="mailto:ezio.melotti@gmail.com">ezio.melotti@gmail.com</a>> wrote:<br>
>  > As far as I know, the only way to report a typo or change something in the<br>>  > documentation is actually open an issue in the bug tracker.<br>>  > This implies that:<br>>  > 1. If the user is not registered to the bug tracker he can't open the issue,<br>
>  > and he won't probably register for a small mistake;<br>>  > 2. The user has to spend some time to reach the bug tracker page, open a new<br>>  > issue, write a brief description of the problem and possibly create and<br>
>  > attach a patch;<br>>  > 3. A developer (of Python) has to read the issue, write a patch or check if<br>>  > the attached patch is ok and then apply it (even if I think that some<br>>  > developers can edit the doc directly).<br>
>  > In my opinion this is rather clumsy and certainly not user-friendly. Even if<br>>  > the user is registered to the bug tracker and knows how to report an issue<br>>  > (and this is already a small subset of the doc readers) he may not want to<br>
>  > go through all these step just to fix a typo.<br>>  ><br>>  > The idea is to allow all the users to edit the documentation pages directly<br>>  > (like a wiki), but wait the approval of a developer before apply the<br>
>  > changes.<br>>  > The steps will then be:<br>>  > 1. The user finds a mistake, clicks on an [edit] link and fixes it;<br>>  > 2. A developer check if the correction is ok and approves of refuses it.<br>
>  ><br>>  <br>>  <br>> Georg can correct me if I am wrong, but I believe he has been working<br>>  on a commenting system for the docs for this exact need. Don't know<br>>  how far along it is, but I am sure any help you can provide to move it<br>
>  along would be appreciated.<br>>  <br>> <br>>  -Brett<br>>  <br>> _______________________________________________<br>>  Python-ideas mailing list<br>>  <a href="mailto:Python-ideas@python.org">Python-ideas@python.org</a><br>
>  <a href="http://mail.python.org/mailman/listinfo/python-ideas">http://mail.python.org/mailman/listinfo/python-ideas</a><br>>  <br><br>