r86860 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r86859‎ | r86860 | r86861 >
Date:14:05, 25 April 2011
Author:maxsem
Status:ok
Tags:
Comment:
Rm all mentions of "this module" in API action descriptions. They are supposed to be read by API users, not MW coders, thus internal terminology shouldn't be used here.
Modified paths:
  • /trunk/phase3/includes/api/ApiExpandTemplates.php (modified) (history)
  • /trunk/phase3/includes/api/ApiFeedWatchlist.php (modified) (history)
  • /trunk/phase3/includes/api/ApiLogin.php (modified) (history)
  • /trunk/phase3/includes/api/ApiLogout.php (modified) (history)
  • /trunk/phase3/includes/api/ApiOpenSearch.php (modified) (history)
  • /trunk/phase3/includes/api/ApiParse.php (modified) (history)
  • /trunk/phase3/includes/api/ApiPurge.php (modified) (history)
  • /trunk/phase3/includes/api/ApiQueryDeletedrevs.php (modified) (history)
  • /trunk/phase3/includes/api/ApiQueryRevisions.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiLogout.php
@@ -64,7 +64,7 @@
6565 }
6666
6767 public function getDescription() {
68 - return 'This module is used to logout and clear session data';
 68+ return 'Log out and clear session data';
6969 }
7070
7171 protected function getExamples() {
Index: trunk/phase3/includes/api/ApiParse.php
@@ -562,7 +562,7 @@
563563 }
564564
565565 public function getDescription() {
566 - return 'This module parses wikitext and returns parser output';
 566+ return 'Parses wikitext and returns parser output';
567567 }
568568
569569 public function getPossibleErrors() {
Index: trunk/phase3/includes/api/ApiPurge.php
@@ -123,7 +123,7 @@
124124
125125 public function getDescription() {
126126 return array( 'Purge the cache for the given titles.',
127 - 'This module requires a POST request if the user is not logged in.'
 127+ 'Requires a POST request if the user is not logged in.'
128128 );
129129 }
130130
Index: trunk/phase3/includes/api/ApiQueryDeletedrevs.php
@@ -374,7 +374,7 @@
375375 $p = $this->getModulePrefix();
376376 return array(
377377 'List deleted revisions.',
378 - 'This module operates in three modes:',
 378+ 'Operates in three modes:',
379379 ' 1) List deleted revisions for the given title(s), sorted by timestamp',
380380 ' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified)',
381381 " 3) List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, {$p}user not set)",
Index: trunk/phase3/includes/api/ApiExpandTemplates.php
@@ -100,7 +100,7 @@
101101 }
102102
103103 public function getDescription() {
104 - return 'This module expand all templates in wikitext';
 104+ return 'Expands all templates in wikitext';
105105 }
106106
107107 protected function getExamples() {
Index: trunk/phase3/includes/api/ApiLogin.php
@@ -181,7 +181,7 @@
182182
183183 public function getDescription() {
184184 return array(
185 - 'This module is used to login and get the authentication tokens. ',
 185+ 'Log in and get the authentication tokens. ',
186186 'In the event of a successful log-in, a cookie will be attached',
187187 'to your session. In the event of a failed log-in, you will not ',
188188 'be able to attempt another log-in through this method for 5 seconds.',
Index: trunk/phase3/includes/api/ApiOpenSearch.php
@@ -116,7 +116,7 @@
117117 }
118118
119119 public function getDescription() {
120 - return 'This module implements OpenSearch protocol';
 120+ return 'Searches the wiki using the OpenSearch protocol';
121121 }
122122
123123 protected function getExamples() {
Index: trunk/phase3/includes/api/ApiQueryRevisions.php
@@ -633,7 +633,7 @@
634634 public function getDescription() {
635635 return array(
636636 'Get revision information',
637 - 'This module may be used in several ways:',
 637+ 'May be used in several ways:',
638638 ' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter',
639639 ' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params',
640640 ' 3) Get data about a set of revisions by setting their IDs with revids parameter',
Index: trunk/phase3/includes/api/ApiFeedWatchlist.php
@@ -194,7 +194,7 @@
195195 }
196196
197197 public function getDescription() {
198 - return 'This module returns a watchlist feed';
 198+ return 'Returns a watchlist feed';
199199 }
200200
201201 protected function getExamples() {

Status & tagging log