jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/984129 )
Change subject: [doc] update documentation ......................................................................
[doc] update documentation
Change-Id: I764ae26ef8dceca9bb62a2534e6ab772c6b3f0dd --- M pywikibot/site/_apisite.py M pywikibot/tools/collections.py 2 files changed, 14 insertions(+), 4 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 250c427..3c46cad 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -572,11 +572,11 @@ >>> limit.delay, limit.ratio # doctest: +SKIP (0.0, inf)
- .. seealso:: :class:`tools.collections.RateLimit` for RateLimit - examples. .. note:: It is not verified whether ``action`` parameter has a valid value. - .. seealso:: :api:`Ratelimit` + .. seealso:: + - :class:`tools.collections.RateLimit` for RateLimit examples. + - :api:`Ratelimit` .. versionadded:: 9.0
:param action: action which might be limited diff --git a/pywikibot/tools/collections.py b/pywikibot/tools/collections.py index 38e330a..cd4d9a9 100644 --- a/pywikibot/tools/collections.py +++ b/pywikibot/tools/collections.py @@ -305,7 +305,8 @@ <pywikibot.site._apisite.APISite.ratelimit>`.
.. note:: :meth:`delay` and :meth:`ratio` properties cannot be - sliced or used with tuple indices. The must be used as attributes. + sliced or used with tuple indices. They must be used as + attributes.
>>> limit = RateLimit('user', 500, 10) >>> limit
pywikibot-commits@lists.wikimedia.org