jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/697444 )
Change subject: [doc] redirect.py: add missing docstring params ......................................................................
[doc] redirect.py: add missing docstring params
Bug: T184115 Change-Id: Id2694e686bc22db841452243f164b7358c4ce2d3 --- M scripts/redirect.py 1 file changed, 12 insertions(+), 2 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/scripts/redirect.py b/scripts/redirect.py index 02ace44..7c43574 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -446,7 +446,13 @@ return page
def delete_redirect(self, page, summary_key) -> None: - """Delete the redirect page.""" + """Delete the redirect page. + + @param page: The page to delete + @type page: pywikibot.page.BasePage + @param summary_key: The message key for the deletion summary + @type summary_key: str + """ assert page.site == self.current_page.site, ( 'target page is on different site {}'.format(page.site)) reason = i18n.twtranslate(page.site, summary_key) @@ -638,7 +644,11 @@ self.fix_1_double_redirect()
def treat(self, page) -> None: - """Treat a page.""" + """Treat a page. + + @param page: Page to be treated. + @type page: pywikibot.page.BasePage + """ if self._treat_counter >= self.opt.limit: pywikibot.output('\nNumber of pages reached the limit. ' 'Script terminated.')
pywikibot-commits@lists.wikimedia.org