Doc #67066 [NEW]: Incorrect documentation for 'long2ip'

From: Date: Sun, 13 Apr 2014 17:58:37 +0000
Subject: Doc #67066 [NEW]: Incorrect documentation for 'long2ip'
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-11139@lists.php.net to get a copy of this message
From: bsasser at sindtech dot net Operating system: n/a PHP version: Irrelevant Package: Documentation problem Bug Type: Documentation Problem Bug description:Incorrect documentation for 'long2ip' Description: ------------ --- From manual page: http://www.php.net/function.long2ip (specifically http://us2.php.net/manual/en/function.long2ip.php ) --- This has similar issues to he ones I just submitted for ip2long. 1) First line states: "long2ip — Converts an (IPv4) Internet network address into a string in Internet standard dotted format" It "converts an (IPv4) Internet network address into a string in Internet standard dotted format"? What's the point of converting it to what we already have? (BTW it is "Dotted Quad Notation" and/or "Dotted Decimal Notation"). This line makes no sense. It should say something like "Converts a long integer to an IPv4 network address in Dotted Quad Notation." 2) Description states: string long2ip ( string $proper_address ) $proper_address is incorrect. You don't pass it an IPv4 address to get an IPv4 address, you pass it a long integer. The statement underneath incorrectly states: "The function long2ip() generates an Internet address in dotted format (i.e.: aaa.bbb.ccc.ddd) from the proper address representation. " Again, this makes no sense. Why convert it from 'the proper address representation' to 'an Internet address'? See #1 above for more clarity. 3) Parameter states: "proper_address A proper address representation." See #2. You don't pass it a "proper address" so it can return a "proper address", you pass it a long integer. Test script: --------------- n/a Expected result: ---------------- Technically accurate documentation. Actual result: -------------- What appears to be late night editing of documentation. -- Edit bug report at https://bugs.php.net/bug.php?id=67066&edit=1 -- Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=67066&r=trysnapshot54 Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=67066&r=trysnapshot55 Try a snapshot (trunk): https://bugs.php.net/fix.php?id=67066&r=trysnapshottrunk Fixed in SVN: https://bugs.php.net/fix.php?id=67066&r=fixed Fixed in release: https://bugs.php.net/fix.php?id=67066&r=alreadyfixed Need backtrace: https://bugs.php.net/fix.php?id=67066&r=needtrace Need Reproduce Script: https://bugs.php.net/fix.php?id=67066&r=needscript Try newer version: https://bugs.php.net/fix.php?id=67066&r=oldversion Not developer issue: https://bugs.php.net/fix.php?id=67066&r=support Expected behavior: https://bugs.php.net/fix.php?id=67066&r=notwrong Not enough info: https://bugs.php.net/fix.php?id=67066&r=notenoughinfo Submitted twice: https://bugs.php.net/fix.php?id=67066&r=submittedtwice register_globals: https://bugs.php.net/fix.php?id=67066&r=globals PHP 4 support discontinued: https://bugs.php.net/fix.php?id=67066&r=php4 Daylight Savings: https://bugs.php.net/fix.php?id=67066&r=dst IIS Stability: https://bugs.php.net/fix.php?id=67066&r=isapi Install GNU Sed: https://bugs.php.net/fix.php?id=67066&r=gnused Floating point limitations: https://bugs.php.net/fix.php?id=67066&r=float No Zend Extensions: https://bugs.php.net/fix.php?id=67066&r=nozend MySQL Configuration Error: https://bugs.php.net/fix.php?id=67066&r=mysqlcfg

« previous php.doc.bugs (#11139) next »