PHP like documentation?

J. Clifford Dyer jcd at sdf.lonestar.org
Sun Feb 15 18:02:03 EST 2009


On Sun, 2009-02-15 at 09:54 -0800, Pavan Mishra wrote:
> I was wondering if I can use python documentation source
> (reStructuredText) and restructure it along the lines of PHP
> documentation. Allowing users to add comments, improving search etc.
> 
> I was thinking if it would be useful.
> --
> http://mail.python.org/mailman/listinfo/python-list
> 

I think it would be useful to have somewhere, but I'm -1 on replacing
the official documentation with it.  I like having the official
documentation more... official.  I like that what you see there has been
fully vetted, edited, and tested.  If there's something wrong with it,
fix it.  If you've got a helpful tip, add it, but it shouldn't be as
easy as commenting to add to the official documentation.  You could
argue that the documentation itself is official, and the comments are
not, but I like not having to worry about what part of the page I'm
looking at.  I also like that google only indexes the official
documentation, and not the comments.  

As I said, it could be very helpful, and I'm not against people having a
place to share their advice, but I'd rather see it happen somewhere
besides python.org. 

Just my thought. 




More information about the Python-list mailing list