https://bugzilla.wikimedia.org/show_bug.cgi?id=56860

       Web browser: ---
            Bug ID: 56860
           Summary: Improve documentation of API's "dir" parameter
           Product: MediaWiki
           Version: unspecified
          Hardware: All
                OS: All
            Status: NEW
          Keywords: easy
          Severity: normal
          Priority: Unprioritized
         Component: API
          Assignee: [email protected]
          Reporter: [email protected]
                CC: [email protected], [email protected],
                    [email protected], [email protected]
            Blocks: 1
    Classification: Unclassified
   Mobile Platform: ---

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.

-- 
You are receiving this mail because:
You are the assignee for the bug.
You are on the CC list for the bug.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to