Topic on User talk:Areefat/Sandbox/API:Options

SSethi (WMF) (talkcontribs)

Thanks a lot for your work on this! Here is a first round of feedback:

  • At the top of the page, in one line explain what the module is about something like "POST request to change preferences of the current user.." and the MediaWiki version like in API:Links.
  • For example section, especially the content before "POST Request", use exactly the format as used here: API:Move#Example
  • About the "Changing options" section:
    • Remove the "Parameters" section and arrange the content in a separate section "Parameter section" using the format like in API:Move#Parameter history
    • The content before "Parameters" section, try to shorten it and then move it in bullet points under a new "Additional notes" section like in API:Move#Additional notes
    • Move Available options to "Example" section after the "Sample Code"
    • After you address all the points above, you can get rid of the "Changing options" section completely :)

Will take another look when you're done :)

Reply to "Feedback 1.0"