Doc #66343 [Wfx]: DateTime static aliases don't have proper signatures on pages.
| From: | donatj at gmail dot com | Date: | Tue, 31 Dec 2013 20:11:57 +0000 |
| Subject: | Doc #66343 [Wfx]: DateTime static aliases don't have proper signatures on pages. | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-10781@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=66343&edit=1
ID: 66343
User updated by: donatj at gmail dot com
Reported by: donatj at gmail dot com
Summary: DateTime static aliases don't have proper signatures
on pages.
Status: Wont fix
Type: Documentation Problem
Package: Documentation problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
My only comment is that the date time methods in particular this would be useful as they're not
direct references but instead have their own signature entirely different from the object which
while documented on the resolved alias page, would be much more useful on the aliases page it self.
Previous Comments:
------------------------------------------------------------------------
[2013-12-31 17:34:11] frozenfire@php.net
In the structure of the PHP manual, alias pages do not have their own signature documentation (see
http://php.net/join for an example). I can understand why it might
be a valuable addition for the DateTime procedural invocations, however it would tend to add a bit
of a maintenance issue, and would unnecessarily complicate the alias page structure.
The function signatures for all of these aliases are present alongside their OOP method signatures,
on the respective method pages. This is the natural place for them.
I'll think about whether we can create a simple pointer structure for the manual to import the
function signature from the method page, but for now, I'll mark this bug as wont-fix.
------------------------------------------------------------------------
[2013-12-23 20:46:14] donatj at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/function.date-offset-get
---
DateTime static aliases don't have proper signatures on pages.
For example, date_offset_get, an alias of DateTime::getOffset should be noted as:
int date_offset_get ( DateTimeInterface $object )
It **is** noted as such here:
http://www.php.net/manual/en/datetime.getoffset.php5
but is not on its own page here:
http://www.php.net/function.date-offset-get
A non-exhaustive list of affected methods follow.
date_add, date_create_from_format, date_create_immutable_from_format, date_create_immutable,
date_create, date_date_set, date_diff, date_format, date_get_last_errors,
date_interval_create_from_date_string ... and many more from the http://us2.php.net/manual/en/ref.datetime.php
section
Expected result:
----------------
int date_offset_get ( DateTimeInterface $object )
Actual result:
--------------
date_offset_get
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=66343&edit=1