On Wed, 6 Nov 2002, Marcus Boerger wrote:
> It return false on failure as documented. I feel we should use this for all
> functions where any failure results in false. This way users easily know
> that they must check for func()!==false
That's something to bring up for discussion but right
now it's not how we document functions. Only resource
should be listed there.
I like your idea of more structure. Right now each manual
entry is full of <notes>'s, parameter descriptions can
sometimes get lost, and what the function does on failure
is also not structured. During the phpdoc meeting awhile
back there was discussion of each manual entry having
a CHANGELOG but that's only part of it.
Here's a rough example (it's late, forgive me):
function in_array:
--------------------------------------------------------------
Parameter | Description | Notes
--------------------------------------------------------------
needle | What is being searched for | Became mixed in
| | PHP 4.2.0
haystack | What we're searching in |
strict | If set to true, the type will | Defaults to false
| also be compared. |
==============================================================
On failure: returns false
--------------------------------------------------------------
Seeing that below the proto might be useful and easy to read.
Anyway, something to think about :)
Regards,
Philip Olson
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
