Revert r106521: creates lots of long, unwrappable lines in help output
authorBrion Vibber <brion@users.mediawiki.org>
Tue, 20 Dec 2011 21:26:57 +0000 (21:26 +0000)
committerBrion Vibber <brion@users.mediawiki.org>
Tue, 20 Dec 2011 21:26:57 +0000 (21:26 +0000)
includes/api/ApiComparePages.php
includes/api/ApiDelete.php
includes/api/ApiEditPage.php
includes/api/ApiEmailUser.php
includes/api/ApiFileRevert.php
includes/api/ApiFormatBase.php
includes/api/ApiHelp.php
includes/api/ApiImport.php
includes/api/ApiLogout.php
includes/api/ApiPurge.php
includes/api/ApiUpload.php

index 7328902..6c22f18 100644 (file)
@@ -120,7 +120,7 @@ class ApiComparePages extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=compare&fromrev=1&torev=2' => 'Creates a diff between revision 1 and 2',
+                       'api.php?action=compare&fromrev=1&torev=2',
                );
        }
 
index fe53b02..6d9a300 100644 (file)
@@ -268,8 +268,8 @@ class ApiDelete extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Deletes the Main Page',
-                       'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Deletes the Main Page with the reason "Preparing for move"',
+                       'api.php?action=delete&title=Main%20Page&token=123ABC',
+                       'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
                );
        }
 
index 216468c..f45f9fd 100644 (file)
@@ -502,14 +502,12 @@ class ApiEditPage extends ApiBase {
 
        public function getExamples() {
                return array(
-
-                       'api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\\'
-                               => 'Edit a page (anonymous user)',
-
-                       'api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=20070824123454&token=%2B\\'
-                               => 'Prepend __NOTOC__ to a page (anonymous user)',
-                       'api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\\'
-                               => 'Undo r13579 through r13585 with autosummary (anonymous user)',
+                       'Edit a page (anonymous user):',
+                       '    api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\\',
+                       'Prepend __NOTOC__ to a page (anonymous user):',
+                       '    api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=20070824123454&token=%2B\\',
+                       'Undo r13579 through r13585 with autosummary (anonymous user):',
+                       '    api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\\',
                );
        }
 
index 004ca73..5a01ae9 100644 (file)
@@ -133,7 +133,7 @@ class ApiEmailUser extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=emailuser&target=WikiSysop&text=Content' => 'Sends an email to the User "WikiSysop" with the text "Content"',
+                       'api.php?action=emailuser&target=WikiSysop&text=Content'
                );
        }
 
index 7ef1da0..0a21680 100644 (file)
@@ -171,8 +171,8 @@ class ApiFileRevert extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\\'
-                               => 'Revert Wiki.png to the version of 20110305152740',
+                       'Revert Wiki.png to the version of 20110305152740:',
+                       '    api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\\',
                );
        }
 
index 7a53b64..a0138ac 100644 (file)
@@ -286,10 +286,7 @@ See <a href='https://www.mediawiki.org/wiki/API'>complete documentation</a>, or
        }
 
        public function getExamples() {
-               return array(
-                       'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
-                               => "Formats the query result in the {$this->getModuleName()} format",
-               );
+               return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName();
        }
 
        public function getHelpUrls() {
index 97da786..d94132a 100644 (file)
@@ -136,11 +136,16 @@ class ApiHelp extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=help' => 'Whole help page',
-                       'api.php?action=help&modules=protect' => 'Module (action) help page',
-                       'api.php?action=help&querymodules=categorymembers' => 'Query (list) modules help page',
-                       'api.php?action=help&querymodules=info' => 'Query (prop) modules help page',
-                       'api.php?action=help&querymodules=siteinfo' => 'Query (meta) modules help page',
+                       'Whole help page:',
+                       '  api.php?action=help',
+                       'Module (action) help page:',
+                       '  api.php?action=help&modules=protect',
+                       'Query (list) modules help page:',
+                       '  api.php?action=help&querymodules=categorymembers',
+                       'Query (prop) modules help page:',
+                       '  api.php?action=help&querymodules=info',
+                       'Query (meta) modules help page:',
+                       '  api.php?action=help&querymodules=siteinfo',
                );
        }
 
index ade9f1f..d38aaf8 100644 (file)
@@ -154,8 +154,8 @@ class ApiImport extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC'
-                               => 'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history',
+                       'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history:',
+                       '  api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC',
                );
        }
 
index 0e4ae53..f530e87 100644 (file)
@@ -64,7 +64,7 @@ class ApiLogout extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=logout' => 'Logs the current user out',
+                       'api.php?action=logout'
                );
        }
 
index 6bf5cb8..d2e0777 100644 (file)
@@ -149,7 +149,7 @@ class ApiPurge extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=purge&titles=Main_Page|API' => 'Purges the "Main Page" and the "API" page',
+                       'api.php?action=purge&titles=Main_Page|API'
                );
        }
 
index e8fc52a..0ac7fb4 100644 (file)
@@ -646,10 +646,10 @@ class ApiUpload extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png'
-                               => 'Upload from a URL',
-                       'api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1'
-                               => 'Complete an upload that failed due to warnings',
+                       'Upload from a URL:',
+                       '    api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png',
+                       'Complete an upload that failed due to warnings:',
+                       '    api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1',
                );
        }