Page MenuHomePhabricator
Create Task
Maniphest T100521

[clonable] APISite and DataSite method docstrings should include a link to the corresponding mw:API help
Closed, ResolvedPublic
Actions

Description

Many APISite and DataSite methods are thin wrappers around a module of the MediaWiki API, and the docstrings for these methods should include a link to the API:<foo> pages on http://mediawiki.org/wiki/API:Main_page

Links should be added using sphinx syntax.

Easy CGI Task: Find three APISite or DataSite methods which are a thin wrapper around a module of the MediaWiki API , and add the appropriate link to the docstring.
Either submit one changeset to Gerrit combining all three amendments, or submit three changesets to Gerrit containing only one amended docstring.

See also https://doc.wikimedia.org/pywikibot/master/mwapi.html (the references are already done for these methods I guess).

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Fix doc in APISite.blockuserpywikibot/coremaster+1 -1
[IMPR] Add corresponding API page links to APISite method docstringspywikibot/coremaster+28 -5
[IMPR] Add corresponding API page links to APISite method docstringspywikibot/coremaster+12 -0
[IMPR] Add corresponding API page links to APISite method docstringspywikibot/coremaster+13 -1
Add corresponding API page links to APISite method docstringspywikibot/coremaster+112 -5
Customize query in gerrit

Related Objects
Search...

Event Timeline

jayvdb created this task.May 27 2015, 3:31 PM
jayvdb raised the priority of this task from to Medium.
jayvdb updated the task description. (Show Details)
jayvdb added projects: Pywikibot-Documentation, good first task.
jayvdb added subscribers: Unknown Object (MLST), valhallasw, Aklapper, jayvdb.
Restricted Application added a project: Documentation. · View Herald TranscriptMay 27 2015, 3:31 PM
jayvdb removed a project: Documentation.May 27 2015, 3:32 PM
jayvdb set Security to None.
Restricted Application added a project: Documentation. · View Herald TranscriptMay 27 2015, 3:32 PM
jayvdb renamed this task from APISite and DataSite method docstrings should include a link to the corresponding mw:API help to [clonable] APISite and DataSite method docstrings should include a link to the corresponding mw:API help.Nov 11 2015, 10:16 PM
jayvdb updated the task description. (Show Details)
jayvdb added a project: Google-Code-In-2015.
jayvdb added a project: Pywikibot.
jayvdb updated the task description. (Show Details)Dec 14 2015, 12:47 PM

https://codein.withgoogle.com/dashboard/tasks/4673196762595328/

jayvdb moved this task from Proposed to Imported into GCI site on the Google-Code-In-2015 board.Dec 14 2015, 12:48 PM
Tokenzero subscribed.Oct 13 2017, 9:39 PM
Restricted Application added a subscriber: TerraCodes. · View Herald TranscriptOct 13 2017, 9:39 PM
jayvdb added a project: Google-Code-in-2017.Jan 4 2018, 3:58 AM

Here is the GCI 2015 task : https://codein.withgoogle.com/archive/2015/organization/4822184463695872/task/5953614677803008/

jayvdb updated the task description. (Show Details)Jan 4 2018, 3:59 AM
jayvdb updated the task description. (Show Details)
jayvdb added a subscriber: MtDu.
jayvdb added a comment.Jan 4 2018, 4:03 AM

Added to 2017 GCI https://codein.withgoogle.com/dashboard/tasks/6029008296738816/

jayvdb moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2017 board.Jan 4 2018, 4:04 AM
Dvorapa moved this task from Backlog to Google Code-in on the Pywikibot-Documentation board.Feb 12 2018, 8:52 PM
• srodlund moved this task from Backlog to API Documentation Request on the Documentation board.Aug 15 2018, 12:40 AM
Dvorapa added a project: Google-Code-in-2018.Nov 2 2018, 11:53 AM
Dvorapa subscribed.
Dvorapa mentioned this in T203122: Organizing the Pywikibot participation to GCI 2018.Nov 2 2018, 1:03 PM
Aklapper added a comment.Nov 5 2018, 1:59 PM

@Dvorapa: Do you plan to mentor this task? If so feel free to create it on the GCI site. :)

Dvorapa added a comment.Nov 5 2018, 3:04 PM

Yes, I'll find some spare time and make GCI tasks for this

Aklapper added a comment.Nov 26 2018, 12:04 AM

@Dvorapa: You have two more weeks for Google-Code-in-2018, if you still plan to. :)

gerritbot subscribed.Mar 17 2019, 7:48 PM

Change 497132 had a related patch set uploaded (by Jeropbrendawm; owner: Jeropbrendawm):
[pywikibot/core@master] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/497132

gerritbot added a project: Patch-For-Review.Mar 17 2019, 7:48 PM
gerritbot added a comment.Mar 18 2019, 4:18 AM

Change 497132 merged by jenkins-bot:
[pywikibot/core@master] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/497132

jeropbrenda mentioned this in T218046: Proposal: Documentation improvements to the ~20 top 70 most-viewed MediaWiki Action API pages, Outreachy Round 18.Mar 18 2019, 6:35 AM
gerritbot added a comment.Mar 21 2019, 12:43 PM

Change 498065 had a related patch set uploaded (by Nikitrain; owner: Nikitrain):
[pywikibot/core@master] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/498065

gerritbot added a comment.Mar 21 2019, 2:03 PM

Change 498095 had a related patch set uploaded (by Nikitrain; owner: Nikitrain):
[pywikibot/core@master] [IMPR] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/498095

gerritbot added a comment.Mar 21 2019, 2:05 PM

Change 498065 abandoned by Nikitrain:
[IMPR] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/498065

gerritbot added a comment.Mar 21 2019, 2:45 PM

Change 498095 merged by jenkins-bot:
[pywikibot/core@master] [IMPR] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/498095

Nikitrain mentioned this in T218015: Proposal: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki, Outreachy 18..Mar 21 2019, 3:14 PM
Didicodes subscribed.Mar 25 2019, 10:06 AM
gerritbot added a comment.Mar 25 2019, 7:19 PM

Change 498977 had a related patch set uploaded (by Didicodes; owner: Didicodes):
[pywikibot/core@master] Add corresponding API page links to APISite method docstrings

https://gerrit.wikimedia.org/r/498977

Didicodes mentioned this in T217966: Proposal: Improving ~20 documentation pages to help MediaWiki users to gain mastery of the value and usage of the Mediawiki Action API - Outreachy 18.Mar 25 2019, 7:30 PM
gerritbot added a comment.Apr 28 2019, 3:21 PM

Change 498977 abandoned by Xqt:
[IMPR] Add corresponding API page links to APISite method docstrings

Reason:
Not applicable for scripts

https://gerrit.wikimedia.org/r/498977

matej_suchanek removed a project: Patch-For-Review.Jan 19 2020, 11:15 AM
Aklapper moved this task from Google Code-in to Backlog on the Pywikibot-Documentation board.Apr 21 2022, 12:13 PM
TBurmeister added a project: Wikimedia-Hackathon-2022.May 21 2022, 12:09 AM
Aklapper moved this task from Backlog to Projects for Newcomers! on the Wikimedia-Hackathon-2022 board.May 21 2022, 12:53 AM
gerritbot added a comment.May 22 2022, 12:15 PM

Change 795374 had a related patch set uploaded (by Hongsy; author: Hongsy):

[pywikibot/core@master] Fix doc in APISite.blockuser

https://gerrit.wikimedia.org/r/795374

gerritbot added a project: Patch-For-Review.May 22 2022, 12:15 PM
hongsy changed the task status from Open to In Progress.May 22 2022, 12:30 PM
hongsy subscribed.

Hello

I noticed the Wikibase APIs do not have a API: link: e.g. https://www.wikidata.org/w/api.php?action=help&modules=wbsearchentities is the standard link to the wbsearchentities API and https://www.mediawiki.org/wiki/API:wbsearchentities doesn't work.

I am wondering if the doc will be rendered correctly if i do something like:

.. seealso:: :api:`wbsearchentities`
gerritbot added a comment.May 22 2022, 1:17 PM

Change 795374 merged by jenkins-bot:

[pywikibot/core@master] Fix doc in APISite.blockuser

https://gerrit.wikimedia.org/r/795374

Xqt removed a project: Patch-For-Review.May 23 2022, 8:49 AM
Xqt subscribed.May 23 2022, 9:03 AM
In T100521#7948118, @hongsy wrote:

Hello

I noticed the Wikibase APIs do not have a API: link: e.g. https://www.wikidata.org/w/api.php?action=help&modules=wbsearchentities is the standard link to the wbsearchentities API and https://www.mediawiki.org/wiki/API:wbsearchentities doesn't work.

I am wondering if the doc will be rendered correctly if i do something like:

.. seealso:: :api:`wbsearchentities`

We use extlinks sphinx extension. The :api: role only points to https://www.mediawiki.org/wiki/API:%s see https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/+/21d409d40bacd47f3e7f502960120419ca35031f/docs/conf.py#359.

Either a new role for wikibase API must be definded (if there are a lot of it) or the a hyper link mustbe used.

Xqt changed the task status from In Progress to Open.Oct 13 2022, 10:19 AM
Xqt updated the task description. (Show Details)
Enag2000 subscribed.Sep 5 2023, 4:37 AM
Enag2000 claimed this task.Sep 6 2023, 5:29 AM

Working on this as a new contributor due to it being tagged "good first task".

Enag2000 removed Enag2000 as the assignee of this task.Sep 14 2023, 4:50 AM
Xqt closed this task as Resolved.Feb 12 2024, 11:13 AM

Most of them are already done

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits