| Index: trunk/phase3/includes/api/ApiMain.php |
| — | — | @@ -752,7 +752,14 @@ |
| 753 | 753 | 'format' => 'The format of the output', |
| 754 | 754 | 'action' => 'What action you would like to perform. See below for module help', |
| 755 | 755 | 'version' => 'When showing help, include version for each module', |
| 756 | | - 'maxlag' => 'Maximum lag', |
| | 756 | + 'maxlag' => array( |
| | 757 | + 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.', |
| | 758 | + 'To save actions causing any more site replication lag, this parameter can make the client', |
| | 759 | + 'wait until the replication lag is less than the specified value.', |
| | 760 | + 'In case of a replag error, a HTTP 503 error is returned, with the message like', |
| | 761 | + '"Waiting for $host: $lag seconds lagged\n".', |
| | 762 | + 'See http://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information', |
| | 763 | + ), |
| 757 | 764 | 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached', |
| 758 | 765 | 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached', |
| 759 | 766 | 'requestid' => 'Request ID to distinguish requests. This will just be output back to you', |