Page MenuHomePhabricator

Documentation-related issues found during Gold Standard Evaluation
Closed, ResolvedPublic

Description

As a part of the gold standard evaluation for pywikibot, I identified several : API:Client code/Evaluations/Pywikibot#Suggested TODOs. --Fhocutt (talk) 19:07, 25 July 2014 (UTC)

Changes that would improve the documentation include:

  • Add code samples to the documentation to provide easy-to-use examples for common tasks (including queries/lists/searches and edits)
  • Add easy-to-find, complete, and intuitive installation instructions to the documentation. This should include installation via pip (T67176: pip install pywikibot is not straightforward) and into virtual environments (T63783: Install fails in virtualenv).
  • Add documentation for people who aren't running bots with existing scripts (particularly researchers who extract data via the API and beginning/intermediate bot writers).
  • Method docstrings should include a link to the corresponding mw:API subpage.

Event Timeline

valhallasw raised the priority of this task from to Needs Triage.
valhallasw updated the task description. (Show Details)
valhallasw subscribed.
Restricted Application added subscribers: Aklapper, Unknown Object (MLST). · View Herald Transcript
Xqt triaged this task as Low priority.Nov 13 2018, 4:15 AM
Xqt subscribed.

The evaluation is not updated for years. On the other hand most or all of these points are done already.

Xqt claimed this task.
Xqt removed Xqt as the assignee of this task.