r108734 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r108733‎ | r108734 | r108735 >
Date:17:36, 12 January 2012
Author:maxsem
Status:ok (Comments)
Tags:
Comment:
Consistency: made all API examples a verbs
Modified paths:
  • /trunk/phase3/includes/api/ApiComparePages.php (modified) (history)
  • /trunk/phase3/includes/api/ApiDelete.php (modified) (history)
  • /trunk/phase3/includes/api/ApiEmailUser.php (modified) (history)
  • /trunk/phase3/includes/api/ApiFormatBase.php (modified) (history)
  • /trunk/phase3/includes/api/ApiLogout.php (modified) (history)
  • /trunk/phase3/includes/api/ApiPurge.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiComparePages.php
@@ -120,7 +120,7 @@
121121
122122 public function getExamples() {
123123 return array(
124 - 'api.php?action=compare&fromrev=1&torev=2' => 'Creates a diff between revision 1 and 2',
 124+ 'api.php?action=compare&fromrev=1&torev=2' => 'Create a diff between revision 1 and 2',
125125 );
126126 }
127127
Index: trunk/phase3/includes/api/ApiLogout.php
@@ -64,7 +64,7 @@
6565
6666 public function getExamples() {
6767 return array(
68 - 'api.php?action=logout' => 'Logs the current user out',
 68+ 'api.php?action=logout' => 'Log the current user out',
6969 );
7070 }
7171
Index: trunk/phase3/includes/api/ApiPurge.php
@@ -149,7 +149,7 @@
150150
151151 public function getExamples() {
152152 return array(
153 - 'api.php?action=purge&titles=Main_Page|API' => 'Purges the "Main Page" and the "API" page',
 153+ 'api.php?action=purge&titles=Main_Page|API' => 'Purge the "Main Page" and the "API" page',
154154 );
155155 }
156156
Index: trunk/phase3/includes/api/ApiDelete.php
@@ -263,8 +263,8 @@
264264
265265 public function getExamples() {
266266 return array(
267 - 'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Deletes the Main Page',
268 - 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Deletes the Main Page with the reason "Preparing for move"',
 267+ 'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Delete the Main Page',
 268+ 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Delete the Main Page with the reason "Preparing for move"',
269269 );
270270 }
271271
Index: trunk/phase3/includes/api/ApiFormatBase.php
@@ -288,7 +288,7 @@
289289 public function getExamples() {
290290 return array(
291291 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
292 - => "Formats the query result in the {$this->getModuleName()} format",
 292+ => "Format the query result in the {$this->getModuleName()} format",
293293 );
294294 }
295295
Index: trunk/phase3/includes/api/ApiEmailUser.php
@@ -133,7 +133,7 @@
134134
135135 public function getExamples() {
136136 return array(
137 - 'api.php?action=emailuser&target=WikiSysop&text=Content' => 'Sends an email to the User "WikiSysop" with the text "Content"',
 137+ 'api.php?action=emailuser&target=WikiSysop&text=Content' => 'Send an email to the User "WikiSysop" with the text "Content"',
138138 );
139139 }
140140

Comments

#Comment by Nikerabbit (talk | contribs)   19:03, 12 January 2012

Both form as verbs, in fact.

Status & tagging log