r23765 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r23764‎ | r23765 | r23766 >
Date:02:19, 6 July 2007
Author:yurik
Status:old
Tags:
Comment:
API: Documentation cleanup
Modified paths:
  • /trunk/phase3/includes/api/ApiFormatBase.php (modified) (history)
  • /trunk/phase3/includes/api/ApiLogin.php (modified) (history)
  • /trunk/phase3/includes/api/ApiMain.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiLogin.php
@@ -227,12 +227,11 @@
228228
229229 protected function getDescription() {
230230 return array (
231 - 'This module is used to login and get the authentication tokens. ' .
232 - 'In the event of a successful log-in, a cookie will be attached ' .
233 - 'to your session. In the event of a failed log-in, you will not ' .
234 - 'be able to attempt another log-in through this method for 60 ' .
235 - 'seconds--this is to prevent its use in aiding automated password ' .
236 - 'crackers.'
 231+ 'This module is used to login and get the authentication tokens. ',
 232+ 'In the event of a successful log-in, a cookie will be attached',
 233+ 'to your session. In the event of a failed log-in, you will not ',
 234+ 'be able to attempt another log-in through this method for 60 seconds.',
 235+ 'This is to prevent password guessing by automated password crackers.'
237236 );
238237 }
239238
Index: trunk/phase3/includes/api/ApiMain.php
@@ -322,14 +322,24 @@
323323 protected function getDescription() {
324324 return array (
325325 '',
326 - 'This API allows programs to access various functions of MediaWiki software.',
327 - 'For more details see API Home Page @ http://www.mediawiki.org/wiki/API',
 326+ '******************************************************************',
 327+ '** **',
 328+ '** This is an auto-generated MediaWiki API documentation page **',
 329+ '** **',
 330+ '** Documentation and Examples: **',
 331+ '** http://www.mediawiki.org/wiki/API **',
 332+ '** **',
 333+ '******************************************************************',
328334 '',
329335 'Status: ALPHA -- all features shown on this page should be working,',
330336 ' but the API is still in active development, and may change at any time.',
331337 ' Make sure you monitor changes to this page, wikitech-l mailing list,',
332338 ' or the source code in the includes/api directory for any changes.',
333 - ''
 339+ '',
 340+ 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
 341+ '',
 342+ '',
 343+ '',
334344 );
335345 }
336346
Index: trunk/phase3/includes/api/ApiFormatBase.php
@@ -110,8 +110,8 @@
111111 <small>
112112 You are looking at the HTML representation of the <?=$this->mFormat?> format.<br/>
113113 HTML is good for debugging, but probably is not suitable for your application.<br/>
114 -Please see "format" parameter documentation at the <a href='api.php'>API help</a>
115 -for more information.
 114+See <a href='http://www.mediawiki.org/wiki/API'>complete documentation</a>, or
 115+<a href='api.php'>API help</a> for more information.
116116 </small>
117117 <?php
118118

Follow-up revisions

RevisionCommit summaryAuthorDate
r23912Merged revisions 23662-23909 via svnmerge from...david18:11, 9 July 2007

Status & tagging log