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
Description
Description
Details
Details
- Reference
- bz64847
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Providing README.rst in scripts and pywikibot. | pywikibot/core | master | +562 -2 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Invalid | None | T72936 Important tasks to be solved (tracking) | |||
| Open | Feature | None | T57880 Functionality existing in compat but missing from core (tracking) | ||
| Resolved | droid | T66847 Provide CONTENTS |
Event Timeline
Comment Actions
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.
Comment Actions
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.
Comment Actions
Adding this to @droid 's Pywikibot-compat-to-core project , as it is something else that should be migrated from compat to core.
Comment Actions
Change 202016 had a related patch set uploaded (by Prianka):
Providing CONTENTS in pywikibot-core.
Comment Actions
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.
Comment Actions
Where shall I add README and config files , Directories ?
Should I format the existing README.rst file in pywikibot-core to add these ?
Comment Actions
Split it into two files, pywikibot/README.rst and scripts/README.rst .
Ensure they are formatted as RST files (restructured text)