Bug #3437 [Opn]: Wrong method name in example
| From: | danielc at analysisandsolutions dot com | Date: | Fri, 11 Feb 2005 19:18:26 +0000 |
| Subject: | Bug #3437 [Opn]: Wrong method name in example | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-5524@lists.php.net to get a copy of this message | ||
Edit report at http://pear.php.net/bugs/bug.php?id=3437&edit=1
ID: 3437
Updated by: danielc@analysisandsolutions.com
Reported By: twinther at chello dot no
Status: Open
Type: Bug
Package: Documentation
Operating System: irrelevant
PHP Version: Irrelevant
New Comment:
In addition, "/**" indicates the start of a docblock. "/*" should be
used throughout the examples unless the comment really is a docblock.
Previous Comments:
------------------------------------------------------------------------
[2005-02-11 12:51:03] twinther at chello dot no
Description:
------------
Hi, this is what I assume is an error in the code listing for 'Example
21-1, Typical usage example for PEAR::Auth', PEAR::Auth, on the page
called 'Introduction'.
A method that doesn't exist in the class is called on line 22.
Reproduce code:
---------------
if ($a->checkAuth()) {
/**
* The output of your site goes here.
*/
}
Expected result:
----------------
An error reporting that checkAuth() is a non-existing method.
The code, I guess, should be:
if ($a->getAuth()) {
/**
* The output of your site goes here.
*/
}
------------------------------------------------------------------------
--
Edit this bug report at http://pear.php.net/bugs/bug.php?id=3437&edit=1