Doc #66480 [NEW]: Ambiguous Language For array_diff() Documentation

From: mpearson at mpearson dot net Operating system: PHP version: Irrelevant Package: Documentation problem Bug Type: Documentation Problem Bug description:Ambiguous Language For array_diff() Documentation Description: ------------ The documentation for array_diff() is a bit ambiguous in the "Description" section. Quote: "Compares array1 against array2 and returns the difference." While the statement is technically true, it is not until the "Return Values" section that the documentation clarifies that excess values in 'array2' will not be returned as well. At a quick glance, if the description matches desired action the "Return Values" section may never be viewed to clarify the ambiguity from the description. My recommendation would be to change the description to something like, " Compares array1 against array2 and returns the values from array1 which are not found in array2." This makes it immediately clear that the values returned will not include non-matching values found in array2. Granted, the confusion could be blamed on the developer for not reviewing the entire documentation, but I am certain I am not the only person that will use a function based on the description matching the desired affect not expecting the description to be ambiguous. Thanks! -- Edit bug report at https://bugs.php.net/bug.php?id=66480&edit=1 -- Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=66480&r=trysnapshot54 Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=66480&r=trysnapshot55 Try a snapshot (trunk): https://bugs.php.net/fix.php?id=66480&r=trysnapshottrunk Fixed in SVN: https://bugs.php.net/fix.php?id=66480&r=fixed Fixed in release: https://bugs.php.net/fix.php?id=66480&r=alreadyfixed Need backtrace: https://bugs.php.net/fix.php?id=66480&r=needtrace Need Reproduce Script: https://bugs.php.net/fix.php?id=66480&r=needscript Try newer version: https://bugs.php.net/fix.php?id=66480&r=oldversion Not developer issue: https://bugs.php.net/fix.php?id=66480&r=support Expected behavior: https://bugs.php.net/fix.php?id=66480&r=notwrong Not enough info: https://bugs.php.net/fix.php?id=66480&r=notenoughinfo Submitted twice: https://bugs.php.net/fix.php?id=66480&r=submittedtwice register_globals: https://bugs.php.net/fix.php?id=66480&r=globals PHP 4 support discontinued: https://bugs.php.net/fix.php?id=66480&r=php4 Daylight Savings: https://bugs.php.net/fix.php?id=66480&r=dst IIS Stability: https://bugs.php.net/fix.php?id=66480&r=isapi Install GNU Sed: https://bugs.php.net/fix.php?id=66480&r=gnused Floating point limitations: https://bugs.php.net/fix.php?id=66480&r=float No Zend Extensions: https://bugs.php.net/fix.php?id=66480&r=nozend MySQL Configuration Error: https://bugs.php.net/fix.php?id=66480&r=mysqlcfg