valhallasw created this task. valhallasw added a subscriber: valhallasw. valhallasw added a project: Pywikibot-documentation. Restricted Application added subscribers: Aklapper, pywikipedia-bugs. Restricted Application added a project: Documentation.
TASK 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}) and into virtual environments ({T63783}). * 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.
TASK DETAIL https://phabricator.wikimedia.org/T100144
EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/
To: valhallasw Cc: pywikipedia-bugs, valhallasw, Aklapper, Spage