Page MenuHomePhabricator

Provide CONTENTS
Closed, ResolvedPublic

Description

CONTENTS provides an overview of all included bots. This should probably be merged with the general docs on WM.org.


Version: core-(2.0)
Severity: normal

Related Objects

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 3:14 AM
bzimport set Reference to bz64847.
bzimport added a subscriber: Unknown Object (????).

These short descriptions are quite useful.

What about copying this to core as pywikibot/README.rst and scripts/README.rst , and have a test that verifies all py files are mentioned in the appropriate file.

Or copy these one line descriptions into the docstrings of each file, if it is better.

Sounds good! One issue with docstrings is that most people don't realize .py files can be opened and inspected for documentation, so providing it as a seperate README is helpful.

jayvdb added a subscriber: droid.

Adding this to @droid 's Pywikibot-compat-to-core project , as it is something else that should be migrated from compat to core.

Change 202016 had a related patch set uploaded (by Prianka):
Providing CONTENTS in pywikibot-core.

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

I agree we should split it two files README.rst as specified, but that shall change the present formatting of the existing file README.rst. Is that fine ? if so I shall do for the same.

I agree we should split it two files README.rst as specified, but that shall change the present formatting of the existing file README.rst. Is that fine ? if so I shall do for the same.

There is no existing files pywikibot/README.rst or scripts/README.rst

Where shall I add README and config files , Directories ?
Should I format the existing README.rst file in pywikibot-core to add these ?

Split it into two files, pywikibot/README.rst and scripts/README.rst .
Ensure they are formatted as RST files (restructured text)

Change 202016 merged by jenkins-bot:
Providing README.rst in scripts and pywikibot.

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

jayvdb assigned this task to droid.