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 #12868 Appendix G Descrepancies..
Submitted: 2001-08-21 00:12 UTC Modified: 2002-05-21 13:21 UTC
From: php at snr-graphics dot com Assigned:
Status: Closed Package: Documentation problem
PHP Version: 4.0.6 OS: win32
Private report: No CVE-ID: None
View Add Comment Developer Edit
 [2001-08-21 00:12 UTC] php at snr-graphics dot com 
This is truly a followup to my previous post - message about what appears to be "descrepancies" in Appendix G.. which has further some confusion as to "which" functions are "truly" an alias and which is the "master function"..

I guess I need to "understand" what the master function is supposed to be, and what an alias is supposed to be.

Perhaps I have these backwards, and thus the confusion, but
some of this doesn't quite set right..

The first function in the list (chop) is labeled as the master function, and it's alias as (rtrim).. but when you go to the master function, (chop) it's documentation indicates it's the alias. and to see rtrim for details.

There are some functions in this list like - fwrite() and fputs() - where fwrite is labled as the master and fputs the alias.. while the documentaion for both functions do not indicate either as an alias.. 

This goes on.. naturally some of these make perfect sense, if you looke at is_double() marked as a master - having aliases of is_float() and is_real().. the documentation corresponds perfectly.. 

i.e. if you call up is_float() or is_real() it directs you to is_double().. which brings "some" understanding back.

and jives with what "I" would preceive as the relationship between a "master function" and an alias.

Input on this matter would "greatly" be appreciated.. 

thanks a bunch.

Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2001-08-21 01:28 UTC] joey@php.net 
I don't understand why it matters which is the 'master'
and which is the alias? I would guess that the reason for
the inconsistency in the documentation is that it really
doesn't matter which is which, so the doc team is not all
that careful about it. But that's just a guess...this
wouldn't be all that hard to clear up.

FWIW, rtrim() is an alias to chop() and fputs() is an alias
to fwrite().
 [2001-08-21 01:28 UTC] joey@php.net 
Update status...
 [2001-08-21 13:35 UTC] jeroen@php.net 
It doesn't matter at all indeed. For chop/rtrim: chop used to be main function, but since it's in perl and behaving differently over there, _and_ rtrim is consistent with trim and ltrim, I decided to document chop as the alias. Will update aliases.xml too.

I recently suggested a better indication to aliases (in phpdoc/README -> CONVENTIONS), but that hasn't been implemented yet -> be patient.

Btw: is_float will be master now, is_double the alias... PHP doesn't have double-precision floats, there's only one flavour.
 [2001-12-11 16:50 UTC] philip@php.net 
This seems okay now.  But, maybe the alias appendix should be auto-generated via something like "genaliasindex" ?
 [2002-05-21 13:21 UTC] tom@php.net 
This bug has been fixed in CVS. You can grab a snapshot of the
CVS version at http://snaps.php.net/. In case this was a documentation 
problem, the fix will show up soon at http://www.php.net/manual/.
In case this was a PHP.net website problem, the change will show
up on the PHP.net site and on the mirror sites.
Thank you for the report, and for helping us make PHP better.
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Fri Apr 19 22:01:28 2024 UTC