From: Lucas Werkmeister <lucas.werkmeister@wikimedia.de>
Date: Thu, 11 Jan 2018 17:02:04 +0000 (+0100)
Subject: Improve PARAM_HELP_MSG_PER_VALUE documentation
X-Git-Tag: 1.31.0-rc.0~931
X-Git-Url: http://git.cyclocoop.org/%27.parametre_url%28%20%20%20generer_action_auteur%28%27charger_plugin%27%2C%20%27update_flux%27%29%2C%27update_flux%27%2C%20%27oui%27%29.%27?a=commitdiff_plain;h=0fe95a7d55bb2270b3b5435798c76c484e4b46ce;p=lhc%2Fweb%2Fwiklou.git

Improve PARAM_HELP_MSG_PER_VALUE documentation

Per-value documentation is only generated if this option is specified,
even if it is only set to an empty array (i. e., when using the default
key for all values). Attempt to make this more clear.

Change-Id: I844df226271aadb1f06b3cc00ba32cc6c06ec76a
---

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 83d2ae9bea..4d7ef289cc 100644
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -155,6 +155,7 @@ abstract class ApiBase extends ContextSource {
 	 * ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array
 	 * mapping those values to $msg for ApiBase::makeMessage(). Any value not
 	 * having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}.
+	 * Specify an empty array to use the default message key for all values.
 	 * @since 1.25
 	 */
 	const PARAM_HELP_MSG_PER_VALUE = 14;