php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #69012 examples in echo documentation are misleading
Submitted: 2015-02-08 02:45 UTC Modified: 2019-02-12 16:16 UTC
From: teo8976 at gmail dot com Assigned: girgias (profile)
Status: Closed Package: Strings related
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
If you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: teo8976 at gmail dot com
New email:
PHP Version: OS:

 

 [2015-02-08 02:45 UTC] teo8976 at gmail dot com 
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

Patches

doc-fix-69012 (last revision 2019-01-20 17:55 UTC by girgias@php.net)

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2016-06-14 16:40 UTC] cmb@php.net
-Status: Open +Status: Verified
 [2017-01-28 12:53 UTC] cmb@php.net
-Package: Documentation problem +Package: Strings related
 [2018-12-31 17:05 UTC] girgias@php.net
-Status: Verified +Status: Assigned -Assigned To: +Assigned To: girgias
 [2019-01-20 17:55 UTC] girgias@php.net 
The following patch has been added/updated:

Patch Name: doc-fix-69012
Revision:   1548006922
URL:        https://bugs.php.net/patch-display.php?bug=69012&patch=doc-fix-69012&revision=1548006922
 [2019-02-12 16:16 UTC] cmb@php.net 
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=346811
Log: Fix #69012: examples in echo documentation are misleading

Patch provided by girgias.
 [2019-02-12 16:16 UTC] cmb@php.net
-Status: Assigned +Status: Closed
 [2019-02-12 16:16 UTC] cmb@php.net 
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.
 [2019-02-18 16:41 UTC] salathe@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=3b37f838c7d9508a608f47a93256b6ce82ce1a25
Log: Fix #69012: examples in echo documentation are misleading
 [2019-02-19 20:22 UTC] salathe@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=98e8f4141d56ff35ef4a1e62c6ebe9739b0bc3a6
Log: Fix #69012: examples in echo documentation are misleading
 [2020-02-07 06:05 UTC] phpdocbot@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=ad34011f878d2914d1482e66b510c8a96873d2dd
Log: Fix #69012: examples in echo documentation are misleading
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Tue Nov 04 11:00:01 2025 UTC