Page MenuHomePhabricator

"Default" message string help on API doc framework is incorrect
Closed, InvalidPublic


The helpful suggestion for the default API doc message name is not correct:
"Default: api-help-query+pageassessments-params-pageinfo", as on the API module help page when no message string with the appropriate namespacing is found, in fact should be "apihelp-query+pageassessments-param-pageinfo".

Event Timeline

Fhocutt raised the priority of this task from to Needs Triage.
Fhocutt updated the task description. (Show Details)
Fhocutt added subscribers: Fhocutt, Anomie.

Where is this mistaken suggestion, specifically? I'm not managing to find it anywhere.

Anomie closed this task as Invalid.EditedJan 19 2016, 8:23 PM
Anomie claimed this task.

It turns out it was a misunderstanding, 'paramname' => 'value' in the array returned from getAllowedParams() sets the default value for the parameter, and the resulting display of the default value was being misinterpreted as telling the default message key name.

Useful follow-up: improve documentation for ApiBase::getAllowedParams().