Doc #69012 [NEW]: examples in echo documentation are misleading
| From: | teo8976 at gmail dot com | Date: | Sun, 08 Feb 2015 02:45:16 +0000 |
| Subject: | Doc #69012 [NEW]: examples in echo documentation are misleading | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-11931@lists.php.net to get a copy of this message | ||
From: teo8976 at gmail dot com
Operating system:
PHP version: Irrelevant
Package: Documentation problem
Bug Type: Documentation Problem
Bug description:examples in echo documentation are misleading
Description:
------------
---
From manual page: http://www.php.net/function.echo
---
Example #1 echo examples
Many of the examples (all except the first one, the 8th and 9th, and the
last three) have nothing to do with echo itself but with how string
literals work. Those examples would make perfect sense replacing 'echo'
with '$somevar='
Putting those examples in the documentation for echo
a) bloats the documentation of one language construct with unrelated
stuff
b) is misleading and ambiguous, potentially leading the reader to
wrongly think that variable substitution in literal strings, or heredoc
syntax, are somehow specific to echo, while they are not and can be used
also without echo
--
Edit bug report at https://bugs.php.net/bug.php?id=69012&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=69012&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=69012&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=69012&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=69012&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=69012&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=69012&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=69012&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=69012&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=69012&r=support
Expected behavior: https://bugs.php.net/fix.php?id=69012&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=69012&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=69012&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=69012&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=69012&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=69012&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=69012&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=69012&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=69012&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=69012&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=69012&r=mysqlcfg