Wikimedia

Pywikibot: Improve docstring style

See https://phabricator.wikimedia.org/T121365

Improve the Pywikibot documentation by improving the docstrings which fail the new PEP 257 rule D403. There were 23 errors that fail the new PEP 257 rule. There are eight (8) remaining errors after https://gerrit.wikimedia.org/r/#/c/264475 has been merged.

Do not fix the docstrings of deprecated methods.

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

Pywikibot is a Python-based framework to write bots for MediaWiki. See https://www.mediawiki.org/wiki/Manual:Pywikibot for more information. See https://www.mediawiki.org/wiki/User:John_Vandenberg/GCI_walk-through for a short introduction to using Pywikibot. Patches can be submitted via Gerrit (you need a MediaWiki.org account). See https://www.mediawiki.org/wiki/Manual:Pywikibot/Gerrit. After you have successfully claimed this task on this site please do use the task in Phabricator for communication instead. This allows more PWB developers to be reached! General development questions can be asked on the Pywikibot mailing list at https://lists.wikimedia.org/mailman/listinfo/pywikipedia-l and the #pywikibot IRC channel (see https://www.mediawiki.org/wiki/MediaWiki_on_IRC ).

Task tags

  • python
  • pep257
  • code quality
  • pywikibot
  • docstrings

Students who completed this task

Mehtab Zafar, jdloft

Task type

  • chrome_reader_mode Documentation / Training

Level

Beginner
close

2015