Page MenuHomePhabricator

commons_information.py Help Message Does not Contain Enough Information
Closed, ResolvedPublic

Description

The help message for commons_information.py does not contain enough information. It is one line in length and does not describe usage or supported parameters. See code snippet and docs screenshot below.

#!/usr/bin/env python3
"""Insert a language template into the description field."""
#
# (C) Pywikibot team, 2015-2023
#
# Distributed under the terms of the MIT license.
#

commons_information_doc.PNG (538×99 px, 6 KB)

A new help message should be written that provides a better description of the bot and usage and parameters for it

Details

Event Timeline

@Ricordisamoa: can you update the bot's documentation?

Xqt triaged this task as High priority.May 9 2024, 12:27 PM
Rubin lowered the priority of this task from High to Low.
Rubin subscribed.

I will try to update documentation

Change #1030040 had a related patch set uploaded (by Rubin; author: Rubin):

[pywikibot/core@master] Adding standard documentation to commons_information.py and fixing some typos inside

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

Change #1030040 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] adding documentation to commons_information.py

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