Bug #8673

Doc for PEAR_ErrorStack::staticPush() wrong

Details

Doc Bug #8673	Doc for PEAR_ErrorStack::staticPush() wrong
Submitted	2006-09-11 13:28 UTC
From	patrick dot strasser at tugraz dot at
Assigned	cellog
Status	Closed
Package	PEAR
PHP Version	Irrelevant
OS	-
Roadmaps	(Not assigned)

Comments

[2006-09-11 13:28 UTC] patrick dot strasser at tugraz dot at

Description:
------------
Documentation for PEAR_ErrorStack::staticPush() says:
"PEAR_Error|null|Exception PEAR_ErrorStack::staticPush ([...])".

The second should be "array" instead, as it calls push() internaly and returns direct.

Moreover the description for the return value of push() and staticPush() is confusing. This could instead be something like: "
returns an array, or a PEAR_Error object if compatibility is turned on, or an Exception, if the Exception class is found."
The word "compatibility" should be linked to manual/en/core.pear.pear-errorstack.intro.php#core.pear.pear-errorstack.intro.merging

Patrick