| Hannes Magnusson 2008-01-13, 8:02 am |
| On Jan 12, 2008 10:25 PM, Herman Radtke <hermanradtke@gmail.com> wrote:
> Hello documentation team,
>
> I am interested in helping to document php. I am developer in Long
> Beach, CA and use php primarily for new web application development.
> I want to give something back to the community as I am familiarizing
> myself with some of more obscure parts of php.
>
> I noticed patches were requested from other new participants, so I
> figure I would provide them in my initial post. The SPL ArrayObject
> had no documentation, so I added some basic information to the count
> and append methods to get people started.
Awesome!
The SPL docs really need some work. There are bunch of docs on
http://www.php.net/~helly/php/ext/spl/ which can be copy&pasted
(including examples) so it's a good starting point.
I assume you will be doing more doc work - so feel free to request an
CVS account on http://php.net/cvs-php (note the "tricky questions")
and commit these patches yourself when the account has been opened.
Note: Our editor (Philip Olson) is currently in vacation for the next
few w s so it could take some time for the account to be opened.
Couple of comments:
> Index: en/reference/spl/arrayobject/count.xml
[snip]
> +echo $arrayobject->count();
This should be count($arrayobject);
> Index: en/reference/spl/arrayobject/append.xml
[snip]
> +print_r($arrayobject[2]);
Note the [2]
> +?>
>
> +]]>
> + </programlisting>
> + &example.outputs;
> + <screen>
> +<![CDATA[
> +ArrayObject Object ( [0] => a [1] => b [2] => c )
This is a full dump of the object :)
And example output should be displayed like when running via cli (or
when clicking "view source" in your browser), i.e. with all the new
lines.
-Hannes
|