Hi there, Stefan Behnel wrote:
But there is another area where help is appreciated. A very important area in fact: *documentation*. While there is quite a bit of documentation both on ElementTree and lxml, there are certainly places where lxml's API and its way of doing XML are hard to access, especially for new users and those who have a fixed (should I say: Java-ish?) mindset on XML. If you want to contribute, helping out in this area is warmly appreciated. Here are a few ideas that would be truely helpful for lxml's user base.
I think the lxml documentation project is a great initiative and I encourage everybody to join in! Besides the topics Stefan mentioned, I think we should consider creating complete API documentation for lxml looking similar to what's on www.python.org for the core library. I think this should include both the ElementTree API and the lxml extensions in one place. lxml extensions to the API should be marked in the docs. I think having a clear overview of the API will help people find and use the numerous somewhat hidden treasures that exist in lxml. So, API volunteers, you don't already need to be an expert on the lxml API. Writing a bit of API doc would be a good way to *become* an expert, though. I will be happy to help get any API docs volunteers on their way, so if you start this, you won't be on your own. I'm excited about this documentation project and I'm hoping we'll get a few great new contributors! Regards, Martijn