Req #66546 [NEW]: Re-wording required to enable correctly documented text for the function
| From: | greg at areteweb dot co dot uk | Date: | Wed, 22 Jan 2014 16:56:08 +0000 |
| Subject: | Req #66546 [NEW]: Re-wording required to enable correctly documented text for the function | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-10867@lists.php.net to get a copy of this message | ||
From: greg at areteweb dot co dot uk
Operating system:
PHP version: Irrelevant
Package: Documentation problem
Bug Type: Feature/Change Request
Bug description:Re-wording required to enable correctly documented text for the function
Description:
------------
---
From manual page: http://www.php.net/function.in-array
---
In the "Description" section, the document states:
> Searches haystack for needle using loose comparison unless strict is
set.
As the function requires "needle" then "haystack", it would make sense
to reword the statement to reflect the function's actual requirements.
e.g. change to:
> Searches with needle in haystack using loose comparison unless strict
is set.
It may seem pedantic, but the wording in the current sentence sincerely
confused me and I was having errors with the function until I read
examples and found the function required needle then haystack.
This change would also bring continuity to the in_array documentation
and match the "Parameters" and "Examples" sections.
Kind Regards,
Greg
--
Edit bug report at https://bugs.php.net/bug.php?id=66546&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=66546&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=66546&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=66546&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=66546&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=66546&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=66546&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=66546&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=66546&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=66546&r=support
Expected behavior: https://bugs.php.net/fix.php?id=66546&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=66546&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=66546&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=66546&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=66546&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=66546&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=66546&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=66546&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=66546&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=66546&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=66546&r=mysqlcfg