Re: about array.xml
| From: | Egon Schmid | Date: | Thu, 03 Jan 2002 18:27:26 +0000 |
| Subject: | Re: about array.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969340699@lists.php.net to get a copy of this message | ||
"Gyozo Papp" <pgerzson@freestart.hu> schrieb im Newsbeitrag
news:20020103112331.89512.qmail@pb1.pair.com...
>
> I've translated the array.xml into Hungarian recently and I found
> some documentaion issue in the file with revision 1.147.
>
> 1) two aliases are documented:
> pos()
> sizeof()
>
> 2) array_unique is working differenly as documented:
> it has been reported as a bug, too:
> http://bugs.php.net/?id=14805
>
> array_unique preserves the latest key and not the first in 4.0.6,
> but the manual states the opposite. (This part of the bug report
> may be a documentation issue.)
>
> The followings are only remarks for 'look and feel better':
>
> 3) usort() (line 3585-3588)
> this para describes exactly what is in ¬e.func-callback;
> except that it points to the 3rd examples.
> Why not remove it and put a ¬e.func-callback; immidiately
> before the 3rd example?
>
> 4) The example results displayed in various ways, in comments
within
> programlisting or a successive para element or simply omitted, but
> in several function page it appears in a screen (or a separate
> programlisting) element.
>
> The results of programlistings code appear
> in comments:
> + array_count_values
> array_flip
> array_fill
> array_keys
> + array_map
> array_pad
> array_splice
> array_sum
> + array_unique
> array_values
> + in_array
> count
>
> in text (within a para element):
> array_diff
> array_filter
> array_intersect
> array_merge
> * array_merge_recursive
> array_pop
> array_push
> * array_rerverse
> array_reduce
> array_shift
> array_unshift
> compact
> each
>
> + means that echo, var_dump() or print_r() is also used on the
> affected variables
> * indicates that it may be reasonable as the result is part of a
> longer explanation.
>
> 5) there is colon in the para 'See also' of the following:
> (corresponding line numbers in paranthesis.
> Note that I used rev 1.147)
> arsort (2507)
> array_push (1272)
> current (2296)
> end (2426)
> extract (2591)
> next (3069)
> pos (3093)
> prev (3132)
> reset (3228)
> rsort (3291)
> sort (3434)
> uasort (3480)
> uksort (3548)
> usort (3733)
>
> Additionally:
> krsort - a space missing between 'natsort</function>'
> and 'and' (2788)
> array_map (904) and array_reduce (1441) - missing ', and'
>
> I am able to make most of the changes (expect the one related
> to the bug 14805), but I need your confirmation as I'm also
> not an old pro in phpdoc :)
Please make the changes. If something goes wrong, there are many
people who can correct it afterwards. You can also apply a fix for
bug #14805.
-Egon