From: William S F. <ws...@fu...> - 2006-10-25 23:26:13
|
John Lenz wrote: > On 10/25/06 15:03, William S Fulton wrote: >> Actually John, the documentation is correct and I've made corrections >> above. If you think anything needs clarification in the docs let me >> know. Certainly the ref/unref should be documented, but that is a >> different issue from what I can see. >> > > Ah, ok. I must have been confused. I'll try and take a look at > documenting ref/unref, maybe copy from the python chapter. > > Although I wonder about using the wiki for this? If we could import the > docs to the wiki, we could update them on the web and then every once in > a while convert them back to our simple html? As long as the wiki > syntax isn't too bad... > There is a bit of documentation on this in the CHANGES file. In fact there is a lot of documentation in there which needs to be put into the main docs. Importing wikis into html and back again sounds like more overhead. Documentation patches work good enough for me. The developers have access to cvs in order to modify the documentation directly. I think the main problem is no-one wants to contribute to the documentation otherwise we'd have more patches for it. If anyone can show me a project where the documentation contributions rocketed up as a result of using a wiki, we should seriously consider your approach. Personally, I think the documentation is quite extensive. It is missing some bits, that requires one person to systematically go through the CHANGES file and add in the missing bits. William |