From bf4c2b6aff5ef893f16c242580df5188dba86476 Mon Sep 17 00:00:00 2001 From: Bryan Davis Date: Tue, 8 Oct 2013 11:51:32 -0600 Subject: [PATCH] Add doc comment to Status explaining use Tim posted a nice explanation of the recommended pattern for using the Status object to wikitech-l. This change copies that explanation into the phpdoc comment block of the Status class in an attempt to propagate the meme. Change-Id: Ia98543caaa829cad443abf0f0f5038b3de943ef8 --- includes/Status.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/includes/Status.php b/includes/Status.php index 7ec1b0f68c..7a84fed109 100644 --- a/includes/Status.php +++ b/includes/Status.php @@ -31,6 +31,11 @@ * An operation which is not OK should have errors so that the user can be * informed as to what went wrong. Calling the fatal() function sets an error * message and simultaneously switches off the OK flag. + * + * The recommended pattern for Status objects is to return a Status object + * unconditionally, i.e. both on success and on failure -- so that the + * developer of the calling code is reminded that the function can fail, and + * so that a lack of error-handling will be explicit. */ class Status { var $ok = true; -- 2.20.1