Page MenuHomePhabricator
Create Task
Maniphest T184115

Pywikibot: Add missing docstring params
Closed, ResolvedPublic
Actions

Description

Pywikibot is a Python-based framework to write bots for MediaWiki (more information).

Each function of the library should have the description of its parameters in its documentation. This doc is present in-code, below the function declaration.

You need to find at least five params without description in the _pywikibot_ directory, understand the part of code to know what it does, add the following desc, and submit your change. Please take the time to understand the syntax of already present description fields to follow it.

You are expected to provide a patch in Wikimedia Gerrit. Documentation on Gerrit is available.

Details

SubjectRepoBranchLines +/-
[DOCS] Pywikibot: Add missing docsting params and update commentspywikibot/coremaster+26 -5
[doc] redirect.py: add missing docstring paramspywikibot/coremaster+12 -2
Add docstrings to catall.py, change_pagelang.py, claimit.pypywikibot/coremaster+32 -8
component: docstring update patch for commentspywikibot/coremaster+94 -8
Pywikibot: Add missing docsting paramspywikibot/coremaster+40 -5
Customize query in gerrit

Related Objects
Search...

Event Timeline

jayvdb created this task.Jan 3 2018, 7:47 PM
Restricted Application added a project: Documentation. · View Herald TranscriptJan 3 2018, 7:47 PM
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript
jayvdb added a comment.Jan 3 2018, 7:49 PM

This was already created as https://codein.withgoogle.com/dashboard/tasks/6189366353330176/ ; I am just creating a Phab task for it.
All commits should reference this Phab task

jayvdb added a project: Google-Code-in-2017.Jan 3 2018, 7:49 PM
jayvdb added a comment.Jan 3 2018, 7:51 PM

Pywikibot docstring params use epytext format.

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:55 PM
Dvorapa added a project: Pywikibot.
• srodlund moved this task from Backlog to Completed, Blocked, Wrong Category, Refinement Needed, or Older Needs Review on the Documentation board.Aug 14 2018, 11:31 PM
Xqt triaged this task as Lowest priority.Sep 13 2018, 2:19 PM
Xqt added a project: good first task.
Xqt added a subtask: T85271: document pywikibot.error and pywikibot.exception.
xSavitar subscribed.Oct 24 2018, 10:39 AM
Framawiki updated the task description. (Show Details)Nov 1 2018, 6:40 PM
Framawiki added a project: Google-Code-in-2018.Nov 1 2018, 6:42 PM

Filled for 2018 as https://codein.withgoogle.com/tasks/5761442767699968/, will mentor with whoever wants it.

xSavitar moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2018 board.Nov 1 2018, 6:49 PM
Dvorapa subscribed.Nov 2 2018, 10:49 AM

@Framawiki It seems ok to me

Dvorapa added a comment.Nov 2 2018, 11:23 AM

I will help with mentoring too

AdityaJ subscribed.Dec 25 2018, 3:18 PM

@jayvdb I would like to work on this task.

Shreyasminocha assigned this task to AdityaJ.Dec 25 2018, 4:05 PM
Dvorapa added a comment.Dec 25 2018, 6:42 PM
In T184115#4843335, @AdityaJ wrote:

@jayvdb I would like to work on this task.

Upload some first patch and we will review it.
I will help if needed. I will also answer any question :)

gerritbot subscribed.Dec 26 2018, 2:30 PM

Change 481332 had a related patch set uploaded (by AdityaJ; owner: AdityaJ):
[pywikibot/core@master] Pywikibot: Add missing docsting params

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

gerritbot added a project: Patch-For-Review.Dec 26 2018, 2:30 PM
AdityaJ added a comment.Dec 26 2018, 3:21 PM

@jayvdb I uploaded the patch but the basic build is failing. I can't figure out the reason behind it. Could you please review the patch https://gerrit.wikimedia.org/r/481332

gerritbot added a comment.Dec 28 2018, 2:37 PM

Change 481332 merged by jenkins-bot:
[pywikibot/core@master] Pywikibot: Add missing docsting params

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

Xqt removed a project: Patch-For-Review.Jan 8 2019, 11:58 AM
AdityaJ mentioned this in T218986: GSoC Proposal: Create a subpage for statistics and charts related to a hashtag search.Mar 22 2019, 11:12 AM
AdityaJ mentioned this in T219899: GSoC Proposal: Develop a tool for use by event organizers to track developer activity.Apr 2 2019, 4:57 PM
Dvorapa added a parent task: T199933: Pywikibot documentation newcomer tasks.May 17 2019, 8:17 AM
mstucky subscribed.Oct 22 2019, 4:23 PM
Morgan11235 subscribed.Oct 24 2019, 4:13 AM

@Dvorapa, I am interested in working on this bug with others from my undergraduate computer science open source class. Is there any area of the code where working on this bug will do the most good?

Dvorapa added a comment.Oct 24 2019, 9:47 PM

Hello, this issue is spread through the whole library. To find some, you can use documentation pages themselves (instead of source code): https://doc.wikimedia.org/pywikibot/master/

gerritbot added a comment.Nov 5 2019, 5:59 PM

Change 548817 had a related patch set uploaded (by Morgan11235; owner: jbowen2):
[pywikibot/core@master] component: Updates to docstring params

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

gerritbot added a project: Patch-For-Review.Nov 5 2019, 5:59 PM
AdityaJ reassigned this task from AdityaJ to Morgan11235.Nov 6 2019, 6:46 AM
Zkhalido added subscribers: Mph8318, Zkhalido.Nov 7 2019, 8:52 PM

The patch above was submitted by @Morgan11235 @mstucky @Zkhalido @Mph8318

gerritbot added a comment.Nov 14 2019, 7:38 AM

Change 548817 merged by jenkins-bot:
[pywikibot/core@master] component: docstring update patch for comments

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

Morgan11235 mentioned this in rPWBC68405684c451: component: docstring update patch for comments.Nov 14 2019, 7:40 AM
Maintenance_bot removed a project: Patch-For-Review.Nov 14 2019, 8:10 AM
Rounak_Saraf subscribed.EditedJan 20 2020, 6:06 PM

I would like to work on this task.

Dvorapa added a comment.Jan 20 2020, 9:18 PM

Awesome! Ask for any help if needed

AdityaJ mentioned this in T248491: GSoC Proposal: Design and Develop a tool to correct false depicts claims manually on Wikimedia Commons.Mar 26 2020, 4:43 PM
Aklapper removed Morgan11235 as the assignee of this task.May 12 2020, 2:22 PM

Resetting assignee as the patch by Morgan11235 has been merged and as others could work on other occurrences of this task.

Xqt closed subtask T85271: document pywikibot.error and pywikibot.exception as Resolved.Nov 10 2020, 4:43 PM
gerritbot added a comment.Dec 3 2020, 7:12 AM

Change 644961 had a related patch set uploaded (by Shubham656jain; owner: Shubham656jain):
[pywikibot/core@master] Add docstrings to catall.py, change_pagelang.py, claimit.py

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

gerritbot added a project: Patch-For-Review.Dec 3 2020, 7:12 AM
gerritbot added a comment.Dec 6 2020, 7:38 AM

Change 644961 merged by jenkins-bot:
[pywikibot/core@master] Add docstrings to catall.py, change_pagelang.py, claimit.py

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

Shubham656jain mentioned this in rPWBCa9ac33b3bf79: Add docstrings to catall.py, change_pagelang.py, claimit.py.Dec 6 2020, 7:41 AM
Maintenance_bot removed a project: Patch-For-Review.Dec 6 2020, 8:10 AM
Kemsguy subscribed.Feb 16 2021, 5:30 PM
gerritbot added a comment.May 31 2021, 5:23 PM

Change 697444 had a related patch set uploaded (by Zabe; author: Zabe):

[pywikibot/core@master] [doc] redirect.py: add missing docstring params

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

gerritbot added a project: Patch-For-Review.May 31 2021, 5:23 PM
Zabe subscribed.May 31 2021, 5:24 PM
gerritbot added a comment.May 31 2021, 6:46 PM

Change 697444 merged by jenkins-bot:

[pywikibot/core@master] [doc] redirect.py: add missing docstring params

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

Maintenance_bot removed a project: Patch-For-Review.May 31 2021, 7:10 PM
Mac-riya subscribed.Jul 26 2021, 1:20 PM
This comment was removed by Mac-riya.
aaronlearns subscribed.Dec 30 2021, 12:09 AM

Going back and forth between the version history and commit history to add some info to the families...

gerritbot added a comment.Feb 3 2022, 4:46 PM

Change 759535 had a related patch set uploaded (by Lorcan; author: Lorcan):

[pywikibot/core@master] [DOCS] Pywikibot: Add missing docsting params and update comments

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

gerritbot added a project: Patch-For-Review.Feb 3 2022, 4:46 PM
gerritbot added a comment.Feb 11 2022, 12:15 PM

Change 759535 merged by jenkins-bot:

[pywikibot/core@master] [DOCS] Pywikibot: Add missing docsting params and update comments

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

Maintenance_bot removed a project: Patch-For-Review.Feb 11 2022, 1:10 PM
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:07 AM
Aklapper moved this task from Backlog to Projects for Newcomers! on the Wikimedia-Hackathon-2022 board.May 21 2022, 12:53 AM
Xqt closed this task as Resolved.Apr 3 2023, 1:45 PM
Xqt claimed this task.
Xqt subscribed.

Hard to find and outdated description for gft

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