jayvdb created this task. jayvdb added a subscriber: jayvdb. jayvdb added projects: pywikibot-core, Pywikibot-documentation, Google-Code-In-2015. Herald added subscribers: pywikibot-bugs-list, Aklapper. Herald added a project: Documentation.
TASK DESCRIPTION Documentation is automatically extracted from the docstrings in the Pywikibot library, and converted into html using `Sphinx` to create https://doc.wikimedia.org/pywikibot/api_ref/index.html Many methods in the library do not have adequate docstrings that describe the parameters, return type and exceptions that may occur. These should be added to docstrings using [[http://epydoc.sourceforge.net/fields.html | epytext ]] fields. When you amend a docstring and submit it to Gerrit, a Jenkins job will automatically validate the docstring, and -1 the changeset if it includes syntax errors. Easy CGI task: amend one docstring to completely and accurately summarise its behaviour, documentings its inputs and outputs. TASK DETAIL https://phabricator.wikimedia.org/T118423 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: jayvdb Cc: Aklapper, jayvdb, pywikibot-bugs-list, Jay8g, Spage _______________________________________________ pywikibot-bugs mailing list pywikibot-bugs@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/pywikibot-bugs
