Wikimedia

Pywikibot: Add hyperlinks in docstrings to the MediaWiki documentation

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

Many APISite and DataSite methods are thin wrappers around a module of the MediaWiki API, and the docstrings for these methods should include a link to the API:<foo> pages on http://mediawiki.org/wiki/API:Main_page

Find five APISite or DataSite methods which are a thin wrapper around a module of the MediaWiki API , and add the appropriate link to the docstring. Links should be added using epytext syntax. If the method does not already have a docstring, write a basic docstring for the method.

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
  • sphinx
  • pywikibot
  • epytext

Students who completed this task

alex

Task type

  • chrome_reader_mode Documentation / Training

Level

Beginner
close

2015