User talk:Anadolocan/Sandbox/API:backlinks

About this board

SSethi (WMF) (talkcontribs)

Thank you for working on this! Neat :-) First round of feedback, all small points:

  • Embed API documentation instead of linking to it.
  • Example 2 and 3 can be combined. Maybe keep Example 2 but include a note in it sharing how you can continue the previous requests.
  • Include MediaWiki version number as in API:Documentation template
  • The format of code in `Response` section of Example 2 got messed up.
  • Example 4 and 5 can be removed and the info in there can go in `Additional notes` section
  • In the `Response` section, you don't need to show the whole thing. For reference see how I've added three dots (...) and got rid of other items here: API:Geosearch#Response 2
Anadolocan (talkcontribs)

Hello, @srishakatux ! Thanks a lot for the feedback :)

I have addressed all the issues and please let me know if I still have to make any changes.

SSethi (WMF) (talkcontribs)

@Anadolocan Almost there!

  • This point that the request is similar to Special:Whatlinkshere in the first line of the article could be moved to "Additional notes" section.
  • In the `Response` section, you don't need to show the whole thing. For reference see how I've added three dots (...) and got rid of other items here: API:Geosearch#Response 2. Let's show at the max 3 items in the query field. For example, see below:
{
    "batchcomplete": "",
    "continue": {
        "blcontinue": "4|2124921",
        "continue": "-||"
    },
    "query": {
        "backlinks": [
            {
                "pageid": 217224,
                "ns": 0,
                "title": "Mainpage",
                "redirect": ""
            },
            {
                "pageid": 217225,
                "ns": 0,
                "title": "Main page",
                "redirect": ""
            },
            ...
        ]
    } 
  • Run your code with Pylint (https://www.pylint.org/), to clean up your code, format it and more. Also send a pull request to this repo: https://github.com/srish/MediaWiki_Action_API_Code_Samples
  • Links in bullet points in "See also" section. Use text instead of links for display
  • For Example 1, in `backlinks.py` file use something more fun for title instead of "Main Page". Someone your role model maybe ;-)
  • Typo in "Possible error" lets use errors, as there could be more..
Reply to "Feedback 1.0"
There are no older topics