Bug #69011 [Com]: contraddiction in echo documentation
| From: | teo8976 at gmail dot com | Date: | Mon, 06 Apr 2015 11:56:44 +0000 |
| Subject: | Bug #69011 [Com]: contraddiction in echo documentation | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-12109@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=69011&edit=1
ID: 69011
Comment by: teo8976 at gmail dot com
Reported by: teo8976 at gmail dot com
Summary: contraddiction in echo documentation
Status: Wont fix
Type: Bug
Package: Doc Build problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
Then you should at least highlight it much more.
Instead of being just an "Additionally...." phrase ending a paragraph, this should be the
very first note just below the syntax and highlighted in some way.
Your documentation system certainly allows you that.
Also, I notice that there's a snippet of code at the end of the description. So how comes you
can't add a snippet of code at the beginning showing the two usages?
Previous Comments:
------------------------------------------------------------------------
[2015-04-06 06:12:40] sobak@php.net
Sorry, but this is how our documentation renderer works. It can be changed, but I doubt anyone will
find the time for such an edge case.
------------------------------------------------------------------------
[2015-02-08 02:35:26] teo8976 at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/function.echo
---
This:
"""
Description
void echo ( string $arg1 [, string $... ] )
"""
is in contraddiction with this:
"""
Additionally, if you want to pass more than one parameter to echo, the parameters must not be
enclosed within parentheses.
"""
The second is true, so the first must be corrected.
It should read something like:
"""
Description
void echo ( string $arg1)
void echo string $arg1 [, string $... ]
"""
And by the way, why on earth not changing the behavior so that it does accept parenthesis with more
than one parameter??
Test script:
---------------
---
From manual page: http://www.php.net/function.echo
---
This:
"""
Description
void echo ( string $arg1 [, string $... ] )
"""
is in contraddiction with this:
"""
Additionally, if you want to pass more than one parameter to echo, the parameters must not be
enclosed within parentheses.
"""
The second is true, so the first must be corrected.
It should read something like:
"""
Description
void echo ( string $arg1)
void echo string $arg1 [, string $... ]
"""
And by the way, why on earth not changing the behavior so that it does accept parenthesis with more
than one parameter??
Expected result:
----------------
---
From manual page: http://www.php.net/function.echo
---
This:
"""
Description
void echo ( string $arg1 [, string $... ] )
"""
is in contraddiction with this:
"""
Additionally, if you want to pass more than one parameter to echo, the parameters must not be
enclosed within parentheses.
"""
The second is true, so the first must be corrected.
It should read something like:
"""
Description
void echo ( string $arg1)
void echo string $arg1 [, string $... ]
"""
And by the way, why on earth not changing the behavior so that it does accept parenthesis with more
than one parameter??
Actual result:
--------------
---
From manual page: http://www.php.net/function.echo
---
This:
"""
Description
void echo ( string $arg1 [, string $... ] )
"""
is in contraddiction with this:
"""
Additionally, if you want to pass more than one parameter to echo, the parameters must not be
enclosed within parentheses.
"""
The second is true, so the first must be corrected.
It should read something like:
"""
Description
void echo ( string $arg1)
void echo string $arg1 [, string $... ]
"""
And by the way, why on earth not changing the behavior so that it does accept parenthesis with more
than one parameter??
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=69011&edit=1