r53753 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:< r53752‎ | r53753 | r53754 >
Date:18:29, 25 July 2009
Author:catrope
Status:ok (Comments)
Tags:
Comment:
Followup to r53702: document $extradata parameter
Modified paths:
  • /trunk/phase3/includes/api/ApiBase.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiBase.php
——@@ -729,7 +729,7 @@
730730 * @param $errorCode string Brief, arbitrary, stable string to allow easy
731731 * automated identification of the error, e.g., 'unknown_action'
732732 * @param $httpRespCode int HTTP response code
733 - * @param $extradata fixme: document this
 733+ * @param $extradata array Data to add to the query result
734734 */
735735 public function dieUsage($description, $errorCode, $httpRespCode = 0, $extradata = null) {
736736 wfProfileClose();

Follow-up revisions

RevisionCommit summaryAuthorDate
r53784Elaborate docs added in r53753 per CR commentcatrope18:24, 26 July 2009

Past revisions this follows-up on

RevisionCommit summaryAuthorDate
r53702Better documentation for dieUsage()...simetrical23:50, 23 July 2009

Comments

#Comment by Simetrical (talk | contribs)   16:52, 26 July 2009

That doesn't actually document much of anything. The documentation doesn't say anything beyond what the variable name does, and it's not enough info for someone to decide whether they need to use the parameter. Compare to $httpRespCode, which presumably everyone doing web development should understand without actual docs. Compare also to the documentation for the first two parameters before and after r53702.

What format is the data in? When should it be used? Try giving an example.

Status & tagging log