Add final period to API module descriptions

Change-Id: Icae68c1ab1fd0006e00a3a9a56ae8f831d3d0d45
This commit is contained in:
addshore 2014-03-09 21:22:47 +01:00 committed by Siebrand
parent ff7d760e79
commit 719d7a2f03
81 changed files with 99 additions and 99 deletions

View file

@ -222,7 +222,7 @@ class ApiBlock extends ApiBase {
}
public function getDescription() {
return 'Block a user';
return 'Block a user.';
}
public function getPossibleErrors() {

View file

@ -157,8 +157,8 @@ class ApiComparePages extends ApiBase {
public function getDescription() {
return array(
'Get the difference between 2 pages',
'You must pass a revision number or a page title or a page ID id for each part (1 and 2)'
'Get the difference between 2 pages.',
'You must pass a revision number or a page title or a page ID id for each part (1 and 2).'
);
}

View file

@ -167,7 +167,7 @@ class ApiCreateAccount extends ApiBase {
}
public function getDescription() {
return 'Create a new user account';
return 'Create a new user account.';
}
public function mustBePosted() {

View file

@ -240,7 +240,7 @@ class ApiDelete extends ApiBase {
}
public function getDescription() {
return 'Delete a page';
return 'Delete a page.';
}
public function getPossibleErrors() {

View file

@ -53,7 +53,7 @@ class ApiDisabled extends ApiBase {
}
public function getDescription() {
return 'This module has been disabled';
return 'This module has been disabled.';
}
public function getExamples() {

View file

@ -492,7 +492,7 @@ class ApiEditPage extends ApiBase {
}
public function getDescription() {
return 'Create and edit pages';
return 'Create and edit pages.';
}
public function getPossibleErrors() {

View file

@ -130,7 +130,7 @@ class ApiEmailUser extends ApiBase {
}
public function getDescription() {
return 'Email a user';
return 'Email a user.';
}
public function getPossibleErrors() {

View file

@ -108,7 +108,7 @@ class ApiExpandTemplates extends ApiBase {
}
public function getDescription() {
return 'Expands all templates in wikitext';
return 'Expands all templates in wikitext.';
}
public function getPossibleErrors() {

View file

@ -208,7 +208,7 @@ class ApiFeedContributions extends ApiBase {
}
public function getDescription() {
return 'Returns a user contributions feed';
return 'Returns a user contributions feed.';
}
public function getPossibleErrors() {

View file

@ -266,7 +266,7 @@ class ApiFeedWatchlist extends ApiBase {
}
public function getDescription() {
return 'Returns a watchlist feed';
return 'Returns a watchlist feed.';
}
public function getPossibleErrors() {

View file

@ -167,7 +167,7 @@ class ApiFileRevert extends ApiBase {
public function getDescription() {
return array(
'Revert a file to an old version'
'Revert a file to an old version.'
);
}

View file

@ -152,7 +152,7 @@ class ApiHelp extends ApiBase {
}
public function getDescription() {
return 'Display this help screen. Or the help screen for the specified module';
return 'Display this help screen. Or the help screen for the specified module.';
}
public function getExamples() {

View file

@ -203,7 +203,7 @@ class ApiImageRotate extends ApiBase {
}
public function getDescription() {
return 'Rotate one or more images';
return 'Rotate one or more images.';
}
public function needsToken() {

View file

@ -151,7 +151,7 @@ class ApiImport extends ApiBase {
return array(
'Import a page from another wiki, or an XML file.',
'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
'sending a file for the "xml" parameter'
'sending a file for the "xml" parameter.'
);
}

View file

@ -261,7 +261,7 @@ class ApiLogin extends ApiBase {
'In the event of a successful log-in, a cookie will be attached to your session.',
'In the event of a failed log-in, you will not be able to attempt another log-in',
'through this method for 5 seconds. This is to prevent password guessing by',
'automated password crackers'
'automated password crackers.'
);
}

View file

@ -59,7 +59,7 @@ class ApiLogout extends ApiBase {
}
public function getDescription() {
return 'Log out and clear session data';
return 'Log out and clear session data.';
}
public function getExamples() {

View file

@ -1111,14 +1111,14 @@ class ApiMain extends ApiBase {
'',
'Status: All features shown on this page should be working, but the API',
' is still in active development, and may change at any time.',
' Make sure to monitor our mailing list for any updates',
' Make sure to monitor our mailing list for any updates.',
'',
'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent',
' with the key "MediaWiki-API-Error" and then both the value of the',
' header and the error code sent back will be set to the same value',
' header and the error code sent back will be set to the same value.',
'',
' In the case of an invalid action being passed, these will have a value',
' of "unknown_action"',
' of "unknown_action".',
'',
' For more information see https://www.mediawiki.org' .
'/wiki/API:Errors_and_warnings',

View file

@ -272,7 +272,7 @@ class ApiMove extends ApiBase {
}
public function getDescription() {
return 'Move a page';
return 'Move a page.';
}
public function getPossibleErrors() {

View file

@ -125,7 +125,7 @@ class ApiOpenSearch extends ApiBase {
}
public function getDescription() {
return 'Search the wiki using the OpenSearch protocol';
return 'Search the wiki using the OpenSearch protocol.';
}
public function getExamples() {

View file

@ -187,10 +187,10 @@ class ApiOptions extends ApiBase {
public function getDescription() {
return array(
'Change preferences of the current user',
'Change preferences of the current user.',
'Only options which are registered in core or in one of installed extensions,',
'or as options with keys prefixed with \'userjs-\' (intended to be used by user',
'scripts), can be set'
'scripts), can be set.'
);
}

View file

@ -349,7 +349,7 @@ class ApiParamInfo extends ApiBase {
}
public function getDescription() {
return 'Obtain information about certain API parameters and errors';
return 'Obtain information about certain API parameters and errors.';
}
public function getExamples() {

View file

@ -818,13 +818,13 @@ class ApiParse extends ApiBase {
$p = $this->getModulePrefix();
return array(
'Parses content and returns parser output',
'Parses content and returns parser output.',
'See the various prop-Modules of action=query to get information from the current' .
'version of a page',
'version of a page.',
'There are several ways to specify the text to parse:',
"1) Specify a page or revision, using {$p}page, {$p}pageid, or {$p}oldid.",
"2) Specify content explicitly, using {$p}text, {$p}title, and {$p}contentmodel.",
"3) Specify only a summary to parse. {$p}prop should be given an empty value",
"3) Specify only a summary to parse. {$p}prop should be given an empty value.",
);
}

View file

@ -109,7 +109,7 @@ class ApiPatrol extends ApiBase {
}
public function getDescription() {
return 'Patrol a page or revision';
return 'Patrol a page or revision.';
}
public function getPossibleErrors() {

View file

@ -212,7 +212,7 @@ class ApiProtect extends ApiBase {
}
public function getDescription() {
return 'Change the protection level of a page';
return 'Change the protection level of a page.';
}
public function getPossibleErrors() {

View file

@ -182,7 +182,7 @@ class ApiPurge extends ApiBase {
public function getDescription() {
return array( 'Purge the cache for the given titles.',
'Requires a POST request if the user is not logged in'
'Requires a POST request if the user is not logged in.'
);
}

View file

@ -736,7 +736,7 @@ class ApiQuery extends ApiBase {
'from the MediaWiki databases,',
'and is loosely based on the old query.php interface.',
'All data modifications will first have to use query to acquire a ' .
'token to prevent abuse from malicious sites'
'token to prevent abuse from malicious sites.'
);
}

View file

@ -225,7 +225,7 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Enumerate all categories';
return 'Enumerate all categories.';
}
public function getExamples() {

View file

@ -394,7 +394,7 @@ class ApiQueryAllImages extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Enumerate all images sequentially';
return 'Enumerate all images sequentially.';
}
public function getPossibleErrors() {

View file

@ -285,7 +285,7 @@ class ApiQueryAllMessages extends ApiQueryBase {
}
public function getDescription() {
return 'Return messages from this site';
return 'Return messages from this site.';
}
public function getExamples() {

View file

@ -341,7 +341,7 @@ class ApiQueryAllPages extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Enumerate all pages sequentially in a given namespace';
return 'Enumerate all pages sequentially in a given namespace.';
}
public function getPossibleErrors() {

View file

@ -438,7 +438,7 @@ class ApiQueryAllUsers extends ApiQueryBase {
}
public function getDescription() {
return 'Enumerate all registered users';
return 'Enumerate all registered users.';
}
public function getPossibleErrors() {

View file

@ -534,13 +534,13 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
public function getDescription() {
switch ( $this->getModuleName() ) {
case 'backlinks':
return 'Find all pages that link to the given page';
return 'Find all pages that link to the given page.';
case 'embeddedin':
return 'Find all pages that embed (transclude) the given title';
return 'Find all pages that embed (transclude) the given title.';
case 'imageusage':
return 'Find all pages that use the given image title';
return 'Find all pages that use the given image title.';
default:
ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
ApiBase::dieDebug( __METHOD__, 'Unknown module name.' );
}
}

View file

@ -408,7 +408,7 @@ class ApiQueryBlocks extends ApiQueryBase {
}
public function getDescription() {
return 'List all blocked users and IP addresses';
return 'List all blocked users and IP addresses.';
}
public function getPossibleErrors() {

View file

@ -254,7 +254,7 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'List all categories the page(s) belong to';
return 'List all categories the page(s) belong to.';
}
public function getPossibleErrors() {

View file

@ -143,7 +143,7 @@ class ApiQueryCategoryInfo extends ApiQueryBase {
}
public function getDescription() {
return 'Returns information about the given categories';
return 'Returns information about the given categories.';
}
public function getExamples() {

View file

@ -401,7 +401,7 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'List all pages in a given category';
return 'List all pages in a given category.';
}
public function getPossibleErrors() {

View file

@ -275,7 +275,7 @@ class ApiQueryContributors extends ApiQueryBase {
public function getDescription() {
return 'Get the list of logged-in contributors and ' .
'the count of anonymous contributors to a page';
'the count of anonymous contributors to a page.';
}
public function getExamples() {

View file

@ -492,12 +492,12 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
return array(
'List deleted revisions.',
'Operates in three modes:',
' 1) List deleted revisions for the given title(s), sorted by timestamp',
' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified)',
' 1) List deleted revisions for the given title(s), sorted by timestamp.',
' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified).',
" 3) List all deleted revisions in the given namespace, sorted by title and timestamp',
' (no titles specified, {$p}user not set)",
' (no titles specified, {$p}user not set).",
'Certain parameters only apply to some modes and are ignored in others.',
'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3',
'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3.',
);
}

View file

@ -50,7 +50,7 @@ class ApiQueryDisabled extends ApiQueryBase {
public function getDescription() {
return array(
'This module has been disabled'
'This module has been disabled.'
);
}

View file

@ -200,7 +200,7 @@ class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'List all files that are duplicates of the given file(s) based on hash values';
return 'List all files that are duplicates of the given file(s) based on hash values.';
}
public function getExamples() {

View file

@ -257,7 +257,7 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Enumerate pages that contain a given URL';
return 'Enumerate pages that contain a given URL.';
}
public function getPossibleErrors() {

View file

@ -150,7 +150,7 @@ class ApiQueryExternalLinks extends ApiQueryBase {
}
public function getDescription() {
return 'Returns all external URLs (not interwikis) from the given page(s)';
return 'Returns all external URLs (not interwikis) from the given page(s).';
}
public function getPossibleErrors() {

View file

@ -104,7 +104,7 @@ class ApiQueryFileRepoInfo extends ApiQueryBase {
}
public function getDescription() {
return 'Return meta information about image repositories configured on the wiki';
return 'Return meta information about image repositories configured on the wiki.';
}
public function getExamples() {

View file

@ -367,7 +367,7 @@ class ApiQueryFilearchive extends ApiQueryBase {
}
public function getDescription() {
return 'Enumerate all deleted files sequentially';
return 'Enumerate all deleted files sequentially.';
}
public function getPossibleErrors() {

View file

@ -231,7 +231,7 @@ class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
return array( 'Find all pages that link to the given interwiki link.',
'Can be used to find all links with a prefix, or',
'all links to a title (with a given prefix).',
'Using neither parameter is effectively "All IW Links"',
'Using neither parameter is effectively "All IW Links".',
);
}

View file

@ -185,7 +185,7 @@ class ApiQueryIWLinks extends ApiQueryBase {
}
public function getDescription() {
return 'Returns all interwiki links from the given page(s)';
return 'Returns all interwiki links from the given page(s).';
}
public function getPossibleErrors() {

View file

@ -873,7 +873,7 @@ class ApiQueryImageInfo extends ApiQueryBase {
}
public function getDescription() {
return 'Returns image information and upload history';
return 'Returns image information and upload history.';
}
public function getPossibleErrors() {

View file

@ -180,7 +180,7 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Returns all images contained on the given page(s)';
return 'Returns all images contained on the given page(s).';
}
public function getExamples() {

View file

@ -231,7 +231,7 @@ class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
'Can be used to find all links with a language code, or',
'all links to a title (with a given language).',
'Using neither parameter is effectively "All Language Links".',
'Note that this may not consider language links added by extensions',
'Note that this may not consider language links added by extensions.',
);
}

View file

@ -213,7 +213,7 @@ class ApiQueryLangLinks extends ApiQueryBase {
}
public function getDescription() {
return 'Returns all interlanguage links from the given page(s)';
return 'Returns all interlanguage links from the given page(s).';
}
public function getPossibleErrors() {

View file

@ -233,7 +233,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
}
public function getDescription() {
return "Returns all {$this->description}s from the given page(s)";
return "Returns all {$this->description}s from the given page(s).";
}
public function getExamples() {

View file

@ -561,7 +561,7 @@ class ApiQueryLogEvents extends ApiQueryBase {
}
public function getDescription() {
return 'Get events from logs';
return 'Get events from logs.';
}
public function getPossibleErrors() {

View file

@ -102,7 +102,7 @@ class ApiQueryPagePropNames extends ApiQueryBase {
}
public function getDescription() {
return 'List all page prop names in use on the wiki';
return 'List all page prop names in use on the wiki.';
}
public function getExamples() {

View file

@ -141,7 +141,7 @@ class ApiQueryPageProps extends ApiQueryBase {
}
public function getDescription() {
return 'Get various properties defined in the page content';
return 'Get various properties defined in the page content.';
}
public function getExamples() {

View file

@ -174,7 +174,7 @@ class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'List all pages using a given page prop';
return 'List all pages using a given page prop.';
}
public function getExamples() {

View file

@ -258,7 +258,7 @@ class ApiQueryProtectedTitles extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'List all titles protected from creation';
return 'List all titles protected from creation.';
}
public function getExamples() {

View file

@ -203,7 +203,7 @@ class ApiQueryQueryPage extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Get a list provided by a QueryPage-based special page';
return 'Get a list provided by a QueryPage-based special page.';
}
public function getPossibleErrors() {

View file

@ -185,13 +185,13 @@ class ApiQueryRandom extends ApiQueryGeneratorBase {
public function getDescription() {
return array(
'Get a set of random pages',
'Get a set of random pages.',
'NOTE: Pages are listed in a fixed sequence, only the starting point is random.',
' This means that if, for example, "Main Page" is the first random page on',
' your list, "List of fictional monkeys" will *always* be second, "List of',
' people on stamps of Vanuatu" third, etc',
' people on stamps of Vanuatu" third, etc.',
'NOTE: If the number of pages in the namespace is lower than rnlimit, you will',
' get fewer pages. You will not get the same page twice'
' get fewer pages. You will not get the same page twice.'
);
}

View file

@ -892,7 +892,7 @@ class ApiQueryRecentChanges extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Enumerate recent changes';
return 'Enumerate recent changes.';
}
public function getPossibleErrors() {

View file

@ -249,7 +249,7 @@ class ApiQueryRedirects extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Returns all redirects to the given page(s)';
return 'Returns all redirects to the given page(s).';
}
public function getExamples() {

View file

@ -874,12 +874,12 @@ class ApiQueryRevisions extends ApiQueryBase {
public function getDescription() {
return array(
'Get revision information',
'Get revision information.',
'May be used in several ways:',
' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter',
' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params',
' 3) Get data about a set of revisions by setting their IDs with revids parameter',
'All parameters marked as (enum) may only be used with a single page (#2)'
' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter.',
' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params.',
' 3) Get data about a set of revisions by setting their IDs with revids parameter.',
'All parameters marked as (enum) may only be used with a single page (#2).'
);
}

View file

@ -416,7 +416,7 @@ class ApiQuerySearch extends ApiQueryGeneratorBase {
}
public function getDescription() {
return 'Perform a full text search';
return 'Perform a full text search.';
}
public function getPossibleErrors() {

View file

@ -821,7 +821,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
}
public function getDescription() {
return 'Return general information about the site';
return 'Return general information about the site.';
}
public function getPossibleErrors() {

View file

@ -129,7 +129,7 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo {
}
public function getDescription() {
return 'Returns image information for stashed images';
return 'Returns image information for stashed images.';
}
public function getExamples() {

View file

@ -188,7 +188,7 @@ class ApiQueryTags extends ApiQueryBase {
}
public function getDescription() {
return 'List change tags';
return 'List change tags.';
}
public function getExamples() {

View file

@ -601,7 +601,7 @@ class ApiQueryContributions extends ApiQueryBase {
}
public function getDescription() {
return 'Get all edits by a user';
return 'Get all edits by a user.';
}
public function getPossibleErrors() {

View file

@ -299,7 +299,7 @@ class ApiQueryUserInfo extends ApiQueryBase {
}
public function getDescription() {
return 'Get information about the current user';
return 'Get information about the current user.';
}
public function getExamples() {

View file

@ -387,7 +387,7 @@ class ApiQueryUsers extends ApiQueryBase {
}
public function getDescription() {
return 'Get information about a list of users';
return 'Get information about a list of users.';
}
public function getExamples() {

View file

@ -674,7 +674,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
}
public function getDescription() {
return "Get all recent changes to pages in the logged in user's watchlist";
return "Get all recent changes to pages in the logged in user's watchlist.";
}
public function getPossibleErrors() {

View file

@ -205,7 +205,7 @@ class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
}
public function getDescription() {
return "Get all pages on the logged in user's watchlist";
return "Get all pages on the logged in user's watchlist.";
}
public function getPossibleErrors() {

View file

@ -217,7 +217,7 @@ class ApiRevisionDelete extends ApiBase {
}
public function getDescription() {
return 'Delete/undelete revisions';
return 'Delete/undelete revisions.';
}
public function getPossibleErrors() {

View file

@ -141,7 +141,7 @@ class ApiRollback extends ApiBase {
public function getDescription() {
return array(
'Undo the last edit to the page. If the last user who edited the page made',
'multiple edits in a row, they will all be rolled back'
'multiple edits in a row, they will all be rolled back.'
);
}

View file

@ -60,7 +60,7 @@ class ApiRsd extends ApiBase {
}
public function getDescription() {
return 'Export an RSD (Really Simple Discovery) schema';
return 'Export an RSD (Really Simple Discovery) schema.';
}
public function getExamples() {

View file

@ -161,7 +161,7 @@ class ApiRunJobs extends ApiBase {
}
public function getDescription() {
return 'Perform periodic tasks or run jobs from the queue';
return 'Perform periodic tasks or run jobs from the queue.';
}
public function getExamples() {

View file

@ -273,7 +273,7 @@ class ApiSetNotificationTimestamp extends ApiBase {
return array( 'Update the notification timestamp for watched pages.',
'This affects the highlighting of changed pages in the watchlist and history,',
'and the sending of email when the "Email me when a page on my watchlist is',
'changed" preference is enabled'
'changed" preference is enabled.'
);
}

View file

@ -98,7 +98,7 @@ class ApiTokens extends ApiBase {
}
public function getDescription() {
return 'Gets tokens for data-modifying actions';
return 'Gets tokens for data-modifying actions.';
}
protected function getExamples() {

View file

@ -131,7 +131,7 @@ class ApiUnblock extends ApiBase {
}
public function getDescription() {
return 'Unblock a user';
return 'Unblock a user.';
}
public function getPossibleErrors() {

View file

@ -143,7 +143,7 @@ class ApiUndelete extends ApiBase {
public function getDescription() {
return array(
'Restore certain revisions of a deleted page. A list of deleted revisions ',
'(including timestamps) can be retrieved through list=deletedrevs'
'(including timestamps) can be retrieved through list=deletedrevs.'
);
}

View file

@ -819,7 +819,7 @@ class ApiUpload extends ApiBase {
' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
' * Complete an earlier upload that failed due to warnings, using the "filekey" parameter',
'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
'sending the "file". Also you must get and send an edit token before doing any upload stuff'
'sending the "file". Also you must get and send an edit token before doing any upload stuff.'
);
}

View file

@ -123,7 +123,7 @@ class ApiUserrights extends ApiBase {
}
public function getDescription() {
return 'Add/remove a user to/from groups';
return 'Add/remove a user to/from groups.';
}
public function needsToken() {

View file

@ -211,7 +211,7 @@ class ApiWatch extends ApiBase {
}
public function getDescription() {
return 'Add or remove pages from/to the current user\'s watchlist';
return 'Add or remove pages from/to the current user\'s watchlist.';
}
public function getPossibleErrors() {