jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1044726?usp=email )
Change subject: [doc] adjust logging functions in documentation
......................................................................
[doc] adjust logging functions in documentation
Change-Id: Ic035554ed64a492f6ddd8dffa0dcb24c40a7e017
---
M HISTORY.rst
M ROADMAP.rst
M pywikibot/bot.py
M pywikibot/tools/formatter.py
4 files changed, 6 insertions(+), 5 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/HISTORY.rst b/HISTORY.rst
index 472eddc..1a23884 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -583,7 +583,7 @@
* L10N updates
* Circumvent circular import in tools module (:phab:`T306760`)
* Don't fix html inside syntaxhighlight parts in fixes.py (:phab:`T306723`)
-* Make layer parameter optional in `pywikibot.debug()` (:phab:`T85620`)
+* Make layer parameter optional in
:func:`pywikibot.debug()<pywikibot.logging.debug>` (:phab:`T85620`)
* Retry for internal_api_error_DBQueryTimeoutError errors due to
:phab:`T297708`
* Handle ParserError within xmlreader.XmlDump.parse() instead of raising an
exception (:phab:`T306134`)
* XMLDumpOldPageGenerator is deprecated in favour of a `content` parameter
(:phab:`T306134`)
diff --git a/ROADMAP.rst b/ROADMAP.rst
index ed7c20a..0f5073b 100644
--- a/ROADMAP.rst
+++ b/ROADMAP.rst
@@ -75,7 +75,7 @@
<pywikibot.site._apisite.APISite.linktrail>` instead
* 7.2.0: Positional arguments *decoder*, *layer* and *newline* for
:mod:`logging` functions where dropped; keyword
arguments must be used instead.
-* 7.2.0: ``tb`` parameter of :func:`exception()<pywikibot.exception>` function
was renamed to ``exc_info``
+* 7.2.0: ``tb`` parameter of :func:`exception()<pywikibot.logging.exception>`
function was renamed to ``exc_info``
* 7.2.0: XMLDumpOldPageGenerator is deprecated in favour of a ``content``
parameter of
:func:`XMLDumpPageGenerator<pagegenerators.XMLDumpPageGenerator>`
(:phab:`T306134`)
* 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in
favour of
diff --git a/pywikibot/bot.py b/pywikibot/bot.py
index cff70ef..a993a1a 100644
--- a/pywikibot/bot.py
+++ b/pywikibot/bot.py
@@ -366,8 +366,8 @@
* :python:`Python Logging Levels<library/logging.html#logging-levels>`
Accordingly, do **not** use print statements in bot code; instead,
- use :func:`pywikibot.output` function and other functions from
- :mod:`pywikibot.logging` module.
+ use :func:`pywikibot.info()<pywikibot.logging.info>` function and
+ other functions from :mod:`pywikibot.logging` module.
.. versionchanged:: 6.2
Different logfiles are used if multiple processes of the same
diff --git a/pywikibot/tools/formatter.py b/pywikibot/tools/formatter.py
index 6ad82f5..59c3ace 100644
--- a/pywikibot/tools/formatter.py
+++ b/pywikibot/tools/formatter.py
@@ -60,7 +60,8 @@
"""Output the text of the current sequence.
.. deprecated:: 9.0
- Use :func:`pywikibot.info` with *out* property
+ Use :func:`pywikibot.info()<pywikibot.logging.info>` with
+ :attr:`out` property.
"""
info(self.out)
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1044726?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: Ic035554ed64a492f6ddd8dffa0dcb24c40a7e017
Gerrit-Change-Number: 1044726
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
