Req #44763 [Ver]: Disable user contributed notes on aliases
| From: | cmb@php.net | Date: | Sat, 17 Mar 2018 12:04:24 +0000 |
| Subject: | Req #44763 [Ver]: Disable user contributed notes on aliases | ||
| References: | 1 | Groups: | php.webmaster |
| Request: | Send a blank email to php-webmaster+get-26867@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=44763&edit=1
ID: 44763
Updated by: cmb@php.net
Reported by: rrf5000 at psu dot edu
Summary: Disable user contributed notes on aliases
Status: Verified
Type: Feature/Change Request
Package: Website problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
The reason I posted this comment was that I stumbled upon user
note 117236[1] which suggest to add a see also link to
date_create_from_format. My first thought was, yes of course, but
actually, DateTime::__construct() already links to
DateTime::createFromFormat(), and both methods already document
their procedural counterparts.
I have not thought about aliases like chop(), which are not even
mentioned in the docs they're aliasing (rtrim() in this case).
This could, however, be changed, e.g. by adding a second
methodsynopsis to rtrim.xml which shows chop(). Then a redirect
from function.chop.php to function.rtrim.php appears to be fine.
[1] <http://www.php.net/manual/en/function.date-create.php#117236>
Previous Comments:
------------------------------------------------------------------------
[2018-03-17 05:28:04] sobak@php.net
@cmb I agree that would simplify implementing the requested behavior but at the same time I think it
would end up terribly unclear to the manual users. We already have a bunch URL redirects (e.g. for
the legacy pages) and I'd myself never think that redirect may indicate an alias.
We need to remember that clicking link on the menu is not the only way people browse the manual. I
often simply go with php.net/[function] and even ignoring that I believe we should stay explicit
about documented features.
------------------------------------------------------------------------
[2018-03-16 23:26:13] cmb@php.net
Can't we "just" redirect the alias pages to the "real thing"
instead?
------------------------------------------------------------------------
[2008-07-20 22:20:36] bjori@php.net
Although it is a good idea I don't think our infrastructure can support it...
------------------------------------------------------------------------
[2008-04-17 15:14:56] rrf5000 at psu dot edu
Description:
------------
This is a documentation suggestion, not a bug report.
I've noticed more than a few times that users will contribute notes on an alias function's
reference page (e.g., Array function sizeof() ) which are already documented on the aliased
function's reference page (i.e., Array function count() ). I think that it would make more
sense to keep the sets of notes the same across the page of aliases and their aliased function, or
disable notes on alias pages to keep duplicate examples and notes from occurring. I believe that
this will keep things cleaner in the long run, especially for users wanting to peruse the function
notes and editors cleaning up the notes.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=44763&edit=1