Doc #66546 [Asn->Csd]: Re-wording required to enable correctly documented text for the function
| From: | girgias@php.net | Date: | Mon, 01 Apr 2019 19:22:25 +0000 |
| Subject: | Doc #66546 [Asn->Csd]: Re-wording required to enable correctly documented text for the function | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-16538@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=66546&edit=1
ID: 66546
Updated by: girgias@php.net
Reported by: greg at areteweb dot co dot uk
Summary: Re-wording required to enable correctly documented
text for the function
-Status: Assigned
+Status: Closed
Type: Documentation Problem
Package: Arrays related
PHP Version: Irrelevant
Assigned To: girgias
Block user comment: N
Private report: N
Previous Comments:
------------------------------------------------------------------------
[2019-04-01 19:16:37] girgias@php.net
Automatic comment from SVN on behalf of girgias
Revision: http://svn.php.net/viewvc/?view=revision&revision=347118
Log: Fix Doc Bug #66546
------------------------------------------------------------------------
[2019-01-20 18:00:09] girgias@php.net
The following patch has been added/updated:
Patch Name: doc-fix-66546
Revision: 1548007209
URL: https://bugs.php.net/patch-display.php?bug=66546&patch=doc-fix-66546&revision=1548007209
------------------------------------------------------------------------
[2014-01-22 16:56:08] greg at areteweb dot co dot uk
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 this bug report at https://bugs.php.net/bug.php?id=66546&edit=1