Last modified: 2014-10-28 14:45:53 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 56860 - Improve documentation of API's "dir" parameter
Improve documentation of API's "dir" parameter
Status: ASSIGNED
Product: MediaWiki
Classification: Unclassified
API (Other open bugs)
1.23.0
All All
: Low enhancement (vote)
: ---
Assigned To: dkontotasiou
: easy
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2013-11-10 14:53 UTC by Helder
Modified: 2014-10-28 14:45 UTC (History)
9 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments
The attached file improves documentation of API's "dir" parameter (which accept values older, newer) (333.09 KB, application/xml)
2014-10-23 18:14 UTC, dkontotasiou
Details

Description Helder 2013-11-10 14:53:10 UTC
Go to
https://en.wikipedia.org/w/api.php
and search for "dir " (with the space). There will be 43 results. Of these, only a few (9 results) have an explanation of the meaning of "newer" and "older", like this:
---------------------------------------------------------------
rvdir - In which direction to enumerate (enum)
   newer - List oldest first. Note: rvstart has to be before rvend.
   older - List newest first (default). Note: rvstart has to be later than rvend.
  One value: newer, older
  Default: older
---------------------------------------------------------------

The others are documented like so:
---------------------------------------------------------------
afldir - The direction in which to enumerate
         One value: newer, older
         Default: older
---------------------------------------------------------------
This could be improved to match the first example above.

It seems includes/api/ApiQueryBase.php has a function getDirectionDescription to help with this.
Comment 1 Anu V 2013-12-20 12:10:01 UTC
I would like to work on this bug. Please assign it to me.
Comment 2 dkontotasiou 2014-10-23 18:14:52 UTC
Created attachment 16870 [details]
The attached file improves documentation of API's "dir" parameter (which accept values older, newer)

'dir' parameter which accepts as values newer, oldest is now properly documented in several places on the attached XML file.
Comment 3 Quim Gil 2014-10-28 14:39:39 UTC
Thank you dkontotasiu. Just wondering, wouldn't it be better to submit a patch for review?
Comment 4 Brad Jorsch 2014-10-28 14:45:53 UTC
(In reply to Quim Gil from comment #3)
> Just wondering, wouldn't it be better to submit a patch for review?

Very much so. A hand-edited version of the auto-generated documentation (that was redone completely in Gerrit change #161093) isn't likely to get results.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links