Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.6.4

Doc Bug #13304 Clarify getAuth() and checkAuth()
Submitted: 2008-03-04 06:48 UTC
From: beni Assigned: aashley
Status: Closed Package: Auth (version 1.5.4)
PHP Version: Irrelevant OS:
Roadmaps: 1.6.0    
Subscription  


 [2008-03-04 06:48 UTC] beni (Benedikt Hallinger)
Description: ------------ For Auth beginners, it is hard to understand what getAuth() and checkAuth() exactly does and when to use what. Please describe the difference in more detail in the APIdocs and in PEARs documentation. Expected result: ---------------- The developer new to auth should be able to distinguish between the purpose of getAuth() and checkAuth(). He should be able to reliably tell when to use which method. Actual result: -------------- The developer is confused because the methods show similaritys.

Comments

 [2008-04-04 02:58 UTC] aashley (Adam Ashley)
This bug has been fixed in CVS. If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET). If this was a problem with the pear.php.net website, the change should be live shortly. Otherwise, the fix will appear in the package's next release. Thank you for the report and for helping us make PEAR better.