jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/497205 ) Change subject: Improve docstrings to the Pywikibot library ...................................................................... Improve docstrings to the Pywikibot library Modified docstrings of specialbots.py by adding epytext fields and links to related API documentation Bug: T118423 Change-Id: I69c92205ddec38e5107bfa3d2c5b99207cb22b30 --- M pywikibot/specialbots.py 1 file changed, 10 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/specialbots.py b/pywikibot/specialbots.py index 2b02bad..7ac5315 100644 --- a/pywikibot/specialbots.py +++ b/pywikibot/specialbots.py @@ -386,7 +386,12 @@ return warn_code in self.aborts def ignore_on_warn(self, warn_code): - """Determine if the warning message should be ignored.""" + """ + Determine if the warning message should be ignored. + + @param warn_code: The warning message + @type warn_code: string + """ if self.ignoreWarning is True: return True else: @@ -400,7 +405,10 @@ @deprecated_args(debug=None) def upload_file(self, file_url, _file_key=None, _offset=0): - """Upload the image at file_url to the target wiki. + """ + Upload the image at file_url to the target wiki. + + @see: U{https://www.mediawiki.org/wiki/API:Upload} Return the filename that was used to upload the image. If the upload fails, ask the user whether to try again or not. -- To view, visit https://gerrit.wikimedia.org/r/497205 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I69c92205ddec38e5107bfa3d2c5b99207cb22b30 Gerrit-Change-Number: 497205 Gerrit-PatchSet: 3 Gerrit-Owner: Didicodes <edidiongasikpo(a)gmail.com> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)