From 809e1c4c9f97695a658911cacfe594a77f87e412 Mon Sep 17 00:00:00 2001 From: Brad Jorsch Date: Tue, 3 Mar 2015 16:46:14 -0500 Subject: [PATCH] API: Add caution to docs for ApiBase::getCustomPrinter Change-Id: I37737cfd65fffa4f19ad35d3443e881acc4918db --- includes/api/ApiBase.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index be5a9c3bba..b03782fa06 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -160,6 +160,9 @@ abstract class ApiBase extends ContextSource { * If the module may only be used with a certain format module, * it should override this method to return an instance of that formatter. * A value of null means the default format will be used. + * @note Do not use this just because you don't want to support non-json + * formats. This should be used only when there is a fundamental + * requirement for a specific format. * @return mixed Instance of a derived class of ApiFormatBase, or null */ public function getCustomPrinter() { -- 2.20.1