From d030da9ddc8893491991e1f33517670809e5a713 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Gerg=C5=91=20Tisza?= Date: Fri, 30 Mar 2018 15:12:25 +0200 Subject: [PATCH] Fix documentation of InfoAction::pageInfo This was added in I702f2f13d3b but doesn't seem to have been true even back then. Change-Id: I797061a6af52fed1b052dc69544fa418563892cc --- includes/actions/InfoAction.php | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/includes/actions/InfoAction.php b/includes/actions/InfoAction.php index 0988f73452..0a4eae8781 100644 --- a/includes/actions/InfoAction.php +++ b/includes/actions/InfoAction.php @@ -195,9 +195,14 @@ class InfoAction extends FormlessAction { } /** - * Returns page information in an easily-manipulated format. Array keys are used so extensions - * may add additional information in arbitrary positions. Array values are arrays with one - * element to be rendered as a header, arrays with two elements to be rendered as a table row. + * Returns an array of info groups (will be rendered as tables), keyed by group ID. + * Group IDs are arbitrary and used so that extensions may add additional information in + * arbitrary positions (and as message keys for section headers for the tables, prefixed + * with 'pageinfo-'). + * Each info group is a non-associative array of info items (rendered as table rows). + * Each info item is an array with two elements: the first describes the type of + * information, the second the value for the current page. Both can be strings (will be + * interpreted as raw HTML) or messages (will be interpreted as plain text and escaped). * * @return array */ -- 2.20.1