On Wed, Dec 23, 2015 at 9:15 AM, John Doe rawzausho@gmail.com wrote:
This task is set for the Google Code-In. It appears that none of the methods have a link to Mediawiki in the docstring. Is this correct?
We do not have many, but there are some, using different syntax style.
$ git grep --context=5 mediawiki.org.*API: pywikibot/site.py pywikibot/site.py- @type expiry: int (days), L{datetime.timedelta}, False (config) pywikibot/site.py- @return: A dictionary with the properties of the site. Each entry in pywikibot/site.py- the dictionary is a tuple of the value and a boolean to save if it pywikibot/site.py- is the default value. pywikibot/site.py- @rtype: dict (the values) pywikibot/site.py: @see: U{https://www.mediawiki.org/wiki/API:Meta#siteinfo_.2F_si%7D pywikibot/site.py- """ pywikibot/site.py- def warn_handler(mod, message): pywikibot/site.py- """Return True if the warning is handled.""" pywikibot/site.py- matched = Siteinfo.WARNING_REGEX.match(message) pywikibot/site.py- if mod == 'siteinfo' and matched: -- pywikibot/site.py- """Iterate all current blocks, in order of creation. pywikibot/site.py- pywikibot/site.py- Note that logevents only logs user blocks, while this method pywikibot/site.py- iterates all blocks including IP ranges. The iterator yields dicts pywikibot/site.py- containing keys corresponding to the block properties pywikibot/site.py: (see L{https://www.mediawiki.org/wiki/API:Blocks%7D). pywikibot/site.py- pywikibot/site.py- @param starttime: start iterating at this Timestamp pywikibot/site.py- @param endtime: stop iterating at this Timestamp pywikibot/site.py- @param reverse: if True, iterate oldest blocks first (default: newest) pywikibot/site.py- @param blockids: only iterate blocks with these id numbers -- pywikibot/site.py- # null edit, page not changed pywikibot/site.py- pywikibot.log(u"Page [[%s]] saved without any changes." pywikibot/site.py- % page.title()) pywikibot/site.py- return True pywikibot/site.py- page.latest_revision_id = result["edit"]["newrevid"] pywikibot/site.py: # see https://www.mediawiki.org/wiki/API:Wikimania_2006_API_discussion#Notes pywikibot/site.py- # not safe to assume that saved text is the same as sent pywikibot/site.py- del page.text pywikibot/site.py- return True pywikibot/site.py- elif result["edit"]["result"] == "Failure": pywikibot/site.py- if "captcha" in result["edit"]: -- pywikibot/site.py- def patrol(self, rcid=None, revid=None, revision=None): pywikibot/site.py- """Return a generator of patrolled pages. pywikibot/site.py- pywikibot/site.py- Pages to be patrolled are identified by rcid, revid or revision. pywikibot/site.py- At least one of the parameters is mandatory. pywikibot/site.py: See https://www.mediawiki.org/wiki/API:Patrol. pywikibot/site.py- pywikibot/site.py- @param rcid: an int/string/iterable/iterator providing rcid of pages pywikibot/site.py- to be patrolled. pywikibot/site.py- @type rcid: iterable/iterator which returns a number or string which pywikibot/site.py- contains only digits; it also supports a string (as above) or int -- pywikibot/site.py- reattempting to upload the file. NOTE: If report_success is True or pywikibot/site.py- None it'll raise an UploadWarning exception if the static boolean is pywikibot/site.py- False. pywikibot/site.py- @type ignore_warnings: bool or callable or iterable of str pywikibot/site.py- @param chunk_size: The chunk size in bytesfor chunked uploading (see pywikibot/site.py: U{https://www.mediawiki.org/wiki/API:Upload#Chunked_uploading%7D). It pywikibot/site.py- will only upload in chunks, if the version number is 1.20 or higher pywikibot/site.py- and the chunk size is positive but lower than the file size. pywikibot/site.py- @type chunk_size: int pywikibot/site.py- @param _file_key: Reuses an already uploaded file using the filekey. If pywikibot/site.py- None (default) it will upload the file.