Doc #69735 [NEW]: array_splice() return value could be confusing
| From: | chealer at gmail dot com | Date: | Sun, 31 May 2015 18:50:45 +0000 |
| Subject: | Doc #69735 [NEW]: array_splice() return value could be confusing | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-12382@lists.php.net to get a copy of this message | ||
From: chealer at gmail dot com
Operating system:
PHP version: Irrelevant
Package: Documentation problem
Bug Type: Documentation Problem
Bug description:array_splice() return value could be confusing
Description:
------------
I spent 10 minutes debugging why
$foo = array_splice($foo, 0, 1);
would remove the wrong element from a 2-element array. I then realized I
has misread the documentation:
---
From manual page: http://www.php.net/function.array-splice
---
Return Values ¶
Returns the array consisting of the extracted elements.
----
I had hastily read the above as "Returns the array without the extracted
elements."
There is no way I could have been confused had I carefully read the
whole sentence, but the sentence is still technically incorrect, since
several arrays can consist of the extracted elements. I might not have
misunderstood had the sentence read:
Returns an array consisting of the extracted elements.
Otherwise, the documentation could specify which array consisting of the
extracted elements is returned.
--
Edit bug report at https://bugs.php.net/bug.php?id=69735&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=69735&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=69735&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=69735&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=69735&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=69735&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=69735&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=69735&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=69735&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=69735&r=support
Expected behavior: https://bugs.php.net/fix.php?id=69735&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=69735&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=69735&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=69735&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=69735&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=69735&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=69735&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=69735&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=69735&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=69735&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=69735&r=mysqlcfg