From: Brad Jorsch <bjorsch@wikimedia.org>
Date: Tue, 3 Mar 2015 21:46:14 +0000 (-0500)
Subject: API: Add caution to docs for ApiBase::getCustomPrinter
X-Git-Tag: 1.31.0-rc.0~12205
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/password.php?a=commitdiff_plain;h=809e1c4c9f97695a658911cacfe594a77f87e412;p=lhc%2Fweb%2Fwiklou.git

API: Add caution to docs for ApiBase::getCustomPrinter

Change-Id: I37737cfd65fffa4f19ad35d3443e881acc4918db
---

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() {