[Pywikibot-commits] [Gerrit] pywikibot/core[master]: tools/__init__.py: Add param info to issue_deprecation_warning.__doc__

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/421056 ) Change subject: tools/__init__.py: Add param info to issue_deprecation_warning.__doc__ ...................................................................... tools/__init__.py: Add param info to issue_deprecation_warning.__doc__ Change-Id: Ib302125e8da2d689ebddfdff2890f18d3b321cd3 --- M pywikibot/tools/__init__.py 1 file changed, 12 insertions(+), 1 deletion(-) Approvals: Framawiki: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 376f1b4..8dba207 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -1356,7 +1356,18 @@ def issue_deprecation_warning(name, instead, depth, warning_class=None): - """Issue a deprecation warning.""" + """Issue a deprecation warning. + + @param name: the name of the deprecated object + @type name: str + @param instead: suggested replacement for the deprecated object + @type instead: str + @param depth: depth + 1 will be used as stacklevel for the warnings + @type depth: int + @param warning_class: a warning class (category) to be used, defaults to + DeprecationWarning + @type warning_class: type + """ if instead: if warning_class is None: warning_class = DeprecationWarning -- To view, visit https://gerrit.wikimedia.org/r/421056 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: Ib302125e8da2d689ebddfdff2890f18d3b321cd3 Gerrit-Change-Number: 421056 Gerrit-PatchSet: 2 Gerrit-Owner: Dalba &lt;dalba.wiki(a)gmail.com&gt; Gerrit-Reviewer: Framawiki &lt;framawiki(a)tools.wmflabs.org&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Zoranzoki21 &lt;zorandori4444(a)gmail.com&gt; Gerrit-Reviewer: jenkins-bot <>