Doc #52199 [Opn->Csd]: DateTime::setDate() return value documentation is unclear

From: Date: Wed, 22 Sep 2010 01:46:01 +0000
Subject: Doc #52199 [Opn->Csd]: DateTime::setDate() return value documentation is unclear
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-5106@lists.php.net to get a copy of this message
Edit report at http://bugs.php.net/bug.php?id=52199&edit=1 ID: 52199 Updated by: cataphract@php.net Reported by: vedad at kajtaz dot net Summary: DateTime::setDate() return value documentation is unclear -Status: Open +Status: Closed Type: Documentation Problem Package: Documentation problem PHP Version: Irrelevant -Assigned To: +Assigned To: cataphract Block user comment: N New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. If the current return is DateTime on success and FALSE on failure and in PHP 5.2 the reutn value changed from NULL to DateTime, the changelog must have been referring to the success return value. But to make it clearer, I added "on success" to the changelog message. Previous Comments: ------------------------------------------------------------------------ [2010-09-22 03:43:14] cataphract@php.net Automatic comment from SVN on behalf of cataphract Revision: http://svn.php.net/viewvc/?view=revision&revision=303654 Log: - Clarified that return value change on DateTime methods is for success cases (closes bug #52199). ------------------------------------------------------------------------ [2010-06-28 14:07:01] vedad at kajtaz dot net Description: ------------ The DateTime::setDate() documentation states that the method "Returns the modified DateTime object or FALSE on failure.". Then, a couple of lines later, in "ChangeLog", it says "5.3.0 Changed the return value from NULL to DateTime." It is unclear whether the method returns NULL or DateTime on success, and whether it returns NULL or FALSE on failure, in PHP 5.2. Thanks, ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/bug.php?id=52199&edit=1

« previous php.doc.bugs (#5106) next »