jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1156412?usp=email )
Change subject: doc: Fix docsig SIG302 issues
......................................................................
doc: Fix docsig SIG302 issues
Change-Id: I5208733aaa60d7307c5a7f98c5b737d32d7df32a
---
M pyproject.toml
M pywikibot/comms/http.py
M pywikibot/date.py
M pywikibot/site/_extensions.py
4 files changed, 21 insertions(+), 24 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Looks good to me, approved
diff --git a/pyproject.toml b/pyproject.toml
index 5e0cf61..d963a79 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -156,7 +156,6 @@
"SIG202",
"SIG203",
"SIG301",
- "SIG302",
"SIG401",
"SIG402",
"SIG404",
diff --git a/pywikibot/comms/http.py b/pywikibot/comms/http.py
index 2044b18..8fab9f0 100644
--- a/pywikibot/comms/http.py
+++ b/pywikibot/comms/http.py
@@ -263,10 +263,10 @@
:param site: The Site to connect to
:param uri: the URI to retrieve
- :keyword Optional[CodecInfo, str] charset: Either a valid charset
- (usable for str.decode()) or None to automatically chose the
- charset from the returned header (defaults to latin-1)
- :keyword Optional[str] protocol: a url scheme
+ :keyword CodecInfo or str or None charset: Either a valid charset
+ (usable for `str.decode()`) or None to automatically chose the
+ charset from the returned header (defaults to latin-1).
+ :keyword str | None protocol: a url scheme
:return: The received data Response
"""
kwargs.setdefault('verify', site.verify_SSL_certificate())
diff --git a/pywikibot/date.py b/pywikibot/date.py
index 6fa55e7..237afac 100644
--- a/pywikibot/date.py
+++ b/pywikibot/date.py
@@ -1,6 +1,6 @@
"""Date data and manipulation module."""
#
-# (C) Pywikibot team, 2003-2024
+# (C) Pywikibot team, 2003-2025
#
# Distributed under the terms of the MIT license.
#
@@ -475,26 +475,24 @@
lambda v: dh(v, 'pattern string', encf, decf)
- :param encf:
- Converts from an integer parameter to another integer or a tuple of
- integers. Depending on the pattern, each integer will be converted to a
- proper string representation, and will be passed as a format argument
- to the pattern::
-
- pattern % encf(value)
-
- This function is a complement of decf.
-
.. versionchanged:: 9.0
*filter* parameter was renamed to *filter_func*
- :param decf:
- Converts a tuple/list of non-negative integers found in the original
- value string
- into a normalized value. The normalized value can be passed right back
- into dh() to produce the original string. This function is a complement
- of encf. dh() interprets %d as a decimal and %s as a roman
- numeral number.
+ :param encf: Converts from an integer parameter to another integer
+ or a tuple of integers. Depending on the pattern, each integer
+ will be converted to a proper string representation, and will be
+ passed as a format argument to the pattern::
+
+ pattern % encf(value)
+
+ This function is a complement of *decf*.
+
+ :param decf: Converts a tuple or list of non-negative integers found
+ in the original value string into a normalized value. The
+ normalized value can be passed right back into :func:`dh` to
+ produce the original string. This function is a complement of
+ *encf*. :func:`dh` interprets ``%d`` as a decimal and ``%s`` as
+ a roman numeral number.
"""
_compPattern, strPattern, decoders = escapePattern2(pattern)
# Encode an integer value into a textual form.
diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py
index 707d2a3..66ea1ff 100644
--- a/pywikibot/site/_extensions.py
+++ b/pywikibot/site/_extensions.py
@@ -28,7 +28,7 @@
def notifications(self, **kwargs):
"""Yield Notification objects from the Echo extension.
- :keyword Optional[str] format: If specified, notifications will
+ :keyword str | None format: If specified, notifications will
be returned formatted this way. Its value is either ``model``,
``special`` or ``None``. Default is ``special``.
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1156412?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: I5208733aaa60d7307c5a7f98c5b737d32d7df32a
Gerrit-Change-Number: 1156412
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]
