I have been reading about how to get involved with the PHP documentation team, and it pointed me to this list. I would like to become involved in helping out the PHP documentation efforts. I looked at the TODO list, and noticed that you guys wanted to have every function documented. I looked into the list, and found one section in which I believe I could do a pretty good job in contributing in, which was the POSIX extension. I am pretty familiar with UNIX systems and wouldn’t mind improving the documentation for these functions to get my feet wet in the documentation. I have attached a patch file for a handful of the POSIX functions for review and feedback. If you want, I can also finish up documenting the rest of the POSIX extension, and move onto other undocumented functions.
Hello Logan,
Welcome to the team! Sounds good, and I was wondering who this purdue guy was that left good doc bug comments within bugs.php.net :)
The patch looks good, thank you for worrying about whitespace. The only problem is that the notes role does not use a <simplelist> like the seealso role does, but rather it uses the <note> tag to separate each note. <note><para>foo</para></note>. This is not clear in the howto/skeletons so they will be updated.
As far as undocumented functions go, there are several hundred. There is a tool (affectionally named "the tool") that is being worked on to pinpoint problems including functions that aren't documented. For now, the doc.php.net site can perform that task but currently lacks the "missing functions" (functions without skeletons in the manual) information. The point here is that the future looks bright!
Please finish up POSIX and when it looks good we'll move towards getting you karma. In your CVS request* you might then say "To work on the documentation, I already created patches that were accepted for the POSIX extension."
Regards, Philip * http://php.net/cvs-php.php
