Page MenuHomePhabricator
Create Task
Maniphest T118423

[clonable] Improve docstrings to the Pywikibot library
Closed, ResolvedPublic
Actions

Description

Documentation is automatically extracted from the docstrings in the Pywikibot library, and converted into html using Sphinx to create
https://doc.wikimedia.org/pywikibot/master/api_ref/index.html

Many methods in the library do not have adequate docstrings that describe the parameters, return type and exceptions that may occur.

These should be added to docstrings using epytext fields.

When you amend a docstring and submit it to Gerrit, a Jenkins job will automatically validate the docstring, and -1 the changeset if it includes syntax errors.

Easy GCI task: amend one docstring to completely and accurately summarise its behaviour, documentings its inputs and outputs.

Mentor: @jayvdb

Details

SubjectRepoBranchLines +/-
Improve docstrings to the Pywikibot librarypywikibot/coremaster+17 -4
Improve docstrings to the Pywikibot librarypywikibot/coremaster+21 -12
Improve docstrings to the Pywikibot librarypywikibot/coremaster+27 -13
Improve docstrings to the Pywikibot librarypywikibot/coremaster+10 -2
Add docstring for cosmetic_changes.CosmeticChangesToolkit.cleanUpLinkspywikibot/coremaster+20 -0
Expand docstring for pagegenerators.LinkedPageGeneratorpywikibot/coremaster+16 -1
Add/improve docstrings for miscellaneous functionspywikibot/coremaster+32 -3
Customize query in gerrit

Related Objects
Search...

Event Timeline

jayvdb created this task.Nov 11 2015, 9:38 PM
jayvdb raised the priority of this task from to Medium.
jayvdb updated the task description. (Show Details)
jayvdb added projects: Pywikibot, Pywikibot-Documentation, Google-Code-In-2015.
jayvdb subscribed.
Restricted Application added a project: Documentation. · View Herald TranscriptNov 11 2015, 9:38 PM
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript
jayvdb added a comment.Nov 11 2015, 9:38 PM

I will be a mentor for this task.

jayvdb renamed this task from Improve docstrings to the Pywikibot library to [clonable] Improve docstrings to the Pywikibot library.Nov 11 2015, 9:51 PM
jayvdb set Security to None.
jayvdb updated the task description. (Show Details)Dec 1 2015, 8:58 PM
Aklapper added a comment.Dec 3 2015, 6:55 PM

Created numerous instances as https://codein.withgoogle.com/dashboard/tasks/5649007678324736/

Aklapper moved this task from Proposed to Imported into GCI site on the Google-Code-In-2015 board.Dec 3 2015, 6:55 PM
gerritbot subscribed.Jan 5 2016, 3:44 AM

Change 262420 had a related patch set uploaded (by Sn1per):
Add/improve docstrings for miscellaneous functions

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

gerritbot added a project: Patch-For-Review.Jan 5 2016, 3:44 AM
gerritbot added a comment.Jan 5 2016, 9:33 PM

Change 262667 had a related patch set uploaded (by Sn1per):
Expand docstring for pagegenerators.LinkedPageGenerator

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

gerritbot added a comment.Jan 5 2016, 9:36 PM

Change 262668 had a related patch set uploaded (by Sn1per):
Add docstring for cosmetic_changes.CosmeticChangesToolkit.cleanUpLinks

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

gerritbot added a comment.Jan 5 2016, 9:37 PM

Change 262420 abandoned by Sn1per:
Add/improve docstrings for miscellaneous functions

Reason:
Split into:

  • If575c131b44cb42c7d6d392b55ba35c3cc1398a3 (pagegenerators.LinkedPageGenerator)
  • 1b655412a4dfaf4c287658d5a012d3bbb46de7e7 (cosmetic_changes.CosmeticChangesToolkit.cleanUpLinks)

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

gerritbot added a comment.Jan 6 2016, 3:39 AM

Change 262667 merged by jenkins-bot:
Expand docstring for pagegenerators.LinkedPageGenerator

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

gerritbot added a comment.Jan 8 2016, 2:58 AM

Change 262668 merged by jenkins-bot:
Add docstring for cosmetic_changes.CosmeticChangesToolkit.cleanUpLinks

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

Nemo_bis mentioned this in T120024: [clonable] Add doctests to Pywikibot library documentation.Jan 9 2016, 10:07 AM
Magul removed a project: Patch-For-Review.Nov 15 2016, 8:59 PM
Dvorapa subscribed.Jul 24 2017, 8:38 PM
This comment was removed by Dvorapa.
Dvorapa moved this task from Backlog to Google Code-in on the Pywikibot-Documentation board.Feb 12 2018, 8:49 PM
• srodlund moved this task from Backlog to Automated and Inline Technical Documentation on the Documentation board.Aug 20 2018, 9:08 PM
xSavitar subscribed.Oct 24 2018, 10:39 AM
Dvorapa added a project: Google-Code-in-2018.Nov 2 2018, 11:53 AM
Dvorapa added a subscriber: Google-Code-in-2018.
Dvorapa removed a subscriber: Google-Code-in-2018.
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:05 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. :)

Dvorapa added a project: good first task.Feb 26 2019, 8:30 PM
Didicodes subscribed.Mar 17 2019, 3:17 PM

Hello @Dvorapa
Is this task still open? Can I work on it?

Dvorapa added a comment.EditedMar 17 2019, 3:24 PM

Hello @Didicodes, yes, it was still not marked as resolved as there are still many methods, that need proper docs. Choose some and try to improve them. Common errors are missing params and return value descriptions, missing links to API or to related methods, missing code samples and ilustrative demonstrations.

Didicodes added a comment.EditedMar 17 2019, 3:42 PM

Great @Dvorapa. To do this, I need to clone the pywikibot repository here right? Then improve the documentation of some methods. Kindly tell me the steps to follow. I am a new contributor! Thank you.

Dvorapa added a comment.Mar 17 2019, 3:47 PM

Not really, see https://www.mediawiki.org/wiki/Manual:Pywikibot/Development for the basics of how to contribute to Pywikibot. GitHub is just a mirror of our code review system on Gerrit. There is a nice manual in https://www.mediawiki.org/wiki/Manual:Pywikibot/Gerrit and also you can see much detailed steps in https://www.mediawiki.org/wiki/Gerrit/Tutorial.

Didicodes added a comment.Mar 17 2019, 8:22 PM

Okay. Thanks

gerritbot added a comment.Mar 17 2019, 11:10 PM

Change 497205 had a related patch set uploaded (by Didicodes; owner: Didicodes):
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

gerritbot added a project: Patch-For-Review.Mar 17 2019, 11:10 PM
gerritbot added a comment.Mar 18 2019, 4:29 AM

Change 497205 merged by jenkins-bot:
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

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 19 2019, 10:09 AM
gerritbot added a comment.Mar 19 2019, 6:07 PM

Change 497580 had a related patch set uploaded (by Nikitrain; owner: Nikitrain):
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

Nikitrain mentioned this in T218015: Proposal: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki, Outreachy 18..Mar 20 2019, 11:53 AM
gerritbot added a comment.Mar 20 2019, 2:57 PM

Change 497580 abandoned by Nikitrain:
Improve docstrings to the Pywikibot library

Reason:
I'm going to send another patch with the same changes.

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

gerritbot added a comment.Mar 20 2019, 3:18 PM

Change 497786 had a related patch set uploaded (by Nikitrain; owner: Nikitrain):
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

gerritbot added a comment.Mar 20 2019, 4:12 PM

Change 497786 abandoned by Nikitrain:
Improve docstrings to the Pywikibot library

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

gerritbot added a comment.Mar 20 2019, 4:28 PM

Change 497804 had a related patch set uploaded (by Nikitrain; owner: Nikitrain):
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

gerritbot added a comment.Mar 20 2019, 7:40 PM

Change 497804 merged by jenkins-bot:
[pywikibot/core@master] Improve docstrings to the Pywikibot library

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

Dvorapa added a parent task: T199933: Pywikibot documentation newcomer tasks.May 17 2019, 8:17 AM
Meno25 updated the task description. (Show Details)Jan 25 2022, 12:16 PM
Xqt closed this task as Resolved.Jan 29 2022, 11:17 AM
Xqt claimed this task.
Xqt subscribed.

Closing this because it is not specific enough and epytext is no longer wanted.

Xqt removed Xqt as the assignee of this task.Jan 29 2022, 11:17 AM
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