Page MenuHomePhabricator

Improve data_ingestion.py docs
Closed, ResolvedPublic

Description

The docs for this script are almost empty and unclear. What do the parameters mean? How to use them? What requirements the script needs? What format of files can the script handle?

Event Timeline

Dvorapa created this task.Apr 19 2020, 10:57 PM
Restricted Application added a project: Pywikibot. · View Herald TranscriptApr 19 2020, 10:57 PM
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript
Dvorapa updated the task description. (Show Details)

@Dvorapa I'm wondering where should the doc changes related to this task take place? Do they need to be in the script file itself in core/scripts/data_ingestion.py in https://gerrit.wikimedia.org/r/#/admin/projects/pywikibot/core?

Hi, yes, that's exactly the place. At the top of the script, almost empty documentation string is currently to be found with a very limited and insufficient explanation of what the script does. Newcomer would have to try the script on some test wiki, look into the code, search for some other resources about the script and finally prepare more detailed doc string

Change 594535 had a related patch set uploaded (by DC Slagel; owner: DC Slagel):
[pywikibot/core@master] [IMPR] Add to docs in scripts/data_ingestion.py

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

Dvorapa closed this task as Resolved.May 9 2020, 8:44 PM
Dvorapa assigned this task to DC_Slagel.
Dvorapa triaged this task as Medium priority.

Change 594535 merged by jenkins-bot:
[pywikibot/core@master] [IMPR] Add to docs in scripts/data_ingestion.py

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