jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1168040?usp=email )
Change subject: doc: Expand thottle module description ...................................................................... doc: Expand thottle module description Change-Id: I83853c764767c30c040bc766e6916a5e541430cf --- M pywikibot/throttle.py 1 file changed, 12 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index 26d38d3..d35960f 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -1,6 +1,16 @@ -"""Mechanics to slow down wiki read and/or write rate.""" +"""Mechanisms to regulate the read and write rate to wiki servers. + +This module defines the :class:`Throttle` class, which ensures that +automated access to wiki servers adheres to responsible rate limits. It +avoids overloading the servers by introducing configurable delays +between requests, and coordinates these limits across processes using a +shared control file ``throttle.ctrl``. + +It supports both read and write throttling, automatic adjustment based +on the number of concurrent bot instances, and optional lag-aware delays. +""" # -# (C) Pywikibot team, 2008-2024 +# (C) Pywikibot team, 2008-2025 # # Distributed under the terms of the MIT license. # -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1168040?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: I83853c764767c30c040bc766e6916a5e541430cf Gerrit-Change-Number: 1168040 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <i...@gno.de> Gerrit-Reviewer: Xqt <i...@gno.de> Gerrit-Reviewer: jenkins-bot
_______________________________________________ Pywikibot-commits mailing list -- pywikibot-commits@lists.wikimedia.org To unsubscribe send an email to pywikibot-commits-le...@lists.wikimedia.org
