jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/486715 )
Change subject: Re-added the warning() documentation
......................................................................
Re-added the warning() documentation
Bug: T85271
Change-Id: I6dfef5a125a409e5e88238071e4dbca7c5f06847
---
M pywikibot/logging.py
1 file changed, 13 insertions(+), 2 deletions(-)
Approvals:
Dalba: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/logging.py b/pywikibot/logging.py
index fd64b76..4cf2691 100644
--- a/pywikibot/logging.py
+++ b/pywikibot/logging.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""Logging functions."""
#
-# (C) Pywikibot team, 2010-2018
+# (C) Pywikibot team, 2010-2019
#
# Distributed under the terms of the MIT license.
#
@@ -149,7 +149,18 @@
def warning(text, decoder=None, newline=True, **kwargs):
- """Output a warning message to the user via the
userinterface."""
+ """Output a warning message to the user via the userinterface.
+
+ @param text: the message the user wants to display.
+ @type text: str
+ @param decoder: If None, text should be a unicode string. Otherwise it
+ should be encoded in the given encoding.
+ @type decoder: str
+ @param newline: If True, a line feed will be added after printing the text.
+ @type newline: bool
+ @param kwargs: The keyword arguments can be found in the python doc:
+
https://docs.python.org/2/howto/logging-cookbook.html#logging-cookbook.
+ """
logoutput(text, decoder, newline, WARNING, **kwargs)
--
To view, visit
https://gerrit.wikimedia.org/r/486715
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: I6dfef5a125a409e5e88238071e4dbca7c5f06847
Gerrit-Change-Number: 486715
Gerrit-PatchSet: 5
Gerrit-Owner: Kaushik Reddy <reddykaushik18(a)gmail.com>
Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com>
Gerrit-Reviewer: Framawiki <framawiki(a)tools.wmflabs.org>
Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl>
Gerrit-Reviewer: jenkins-bot (75)
Gerrit-CC: Dvorapa <dvorapa(a)seznam.cz>
Gerrit-CC: Xqt <info(a)gno.de>