From 00905c85a511a0129be113b0c5da5dfa08667813 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Tue, 13 Oct 2015 23:30:04 +0200 Subject: [PATCH] ApiMessage: Improve documentation Based on an excerpt from Anomie's IRC conversation with me. Change-Id: I02661548a30fd40eaa72d77c98a6801dbbaff456 --- includes/api/ApiMessage.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/includes/api/ApiMessage.php b/includes/api/ApiMessage.php index db826a68a6..370911abd9 100644 --- a/includes/api/ApiMessage.php +++ b/includes/api/ApiMessage.php @@ -23,6 +23,12 @@ /** * Interface for messages with machine-readable data for use by the API + * + * The idea is that it's a Message that has some extra data for the API to use when interpreting it + * as an error (or, in the future, as a warning). Internals of MediaWiki often use messages (or + * message keys, or Status objects containing messages) to pass information about errors to the user + * (see e.g. Title::getUserPermissionsErrors()) and the API has to make do with that. + * * @since 1.25 * @ingroup API */ -- 2.20.1