jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/954395 )
Change subject: [doc] update mw_version doc
......................................................................
[doc] update mw_version doc
Change-Id: I4c9ec829c96926e60cacb7100e162c45707aaf8d
---
M pywikibot/site/_apisite.py
1 file changed, 16 insertions(+), 7 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py
index ea9ba8c..636fcf5 100644
--- a/pywikibot/site/_apisite.py
+++ b/pywikibot/site/_apisite.py
@@ -1124,7 +1124,7 @@
def version(self) -> str:
"""Return live project version number as a string.
- Use :py:obj:`pywikibot.site.mw_version` to compare MediaWiki versions.
+ Use :attr:`mw_version` to compare MediaWiki versions.
"""
try:
version = self.siteinfo.get('generator', expiry=1).split(' ')[1]
@@ -1136,18 +1136,18 @@
raise
if MediaWikiVersion(version) < '1.27':
- raise RuntimeError(
- 'Pywikibot "{}" does not support MediaWiki "{}".\n'
- 'Use Pywikibot prior to "8.0" branch instead.'
- .format(pywikibot.__version__, version))
+ raise RuntimeError(f'Pywikibot "{pywikibot.__version__}" does not '
+ f'support MediaWiki "{version}".\n'
+ f'Use Pywikibot prior to "8.0" branch instead.')
return version
@property
def mw_version(self) -> MediaWikiVersion:
- """Return self.version() as a MediaWikiVersion object.
+ """Return :meth:`version()<pywikibot.site._apisite.APISite.version>`
+ as a :class:`tools.MediaWikiVersion` object.
Cache the result for 24 hours.
- """
+ """ # noqa: D205, D400
mw_ver, cache_time = getattr(self, '_mw_version_time', (None, None))
if (
mw_ver is None
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/954395
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I4c9ec829c96926e60cacb7100e162c45707aaf8d
Gerrit-Change-Number: 954395
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
