summaryrefslogtreecommitdiff
path: root/swift/obj/updater.py
diff options
context:
space:
mode:
authorTim Burke <tim.burke@gmail.com>2022-08-02 11:51:24 -0700
committerTim Burke <tim.burke@gmail.com>2022-08-02 14:28:36 -0700
commit52a4fe37aa071b453c4d64acc27f6f499b13543c (patch)
tree26db7984371918ea4d152c852f96200fbdc0b188 /swift/obj/updater.py
parent7e5c78423f5c5482bd36596b23c78e20ab9c40bf (diff)
downloadswift-52a4fe37aa071b453c4d64acc27f6f499b13543c.tar.gz
Various doc formatting cleanups
* Get rid of a bunch of accidental blockquote formatting * Always declare a lexer to use for ``.. code::`` blocks Change-Id: I8940e75b094843e542e815dde6b6be4740751813
Diffstat (limited to 'swift/obj/updater.py')
-rw-r--r--swift/obj/updater.py22
1 files changed, 11 insertions, 11 deletions
diff --git a/swift/obj/updater.py b/swift/obj/updater.py
index 2ee7c35fa..1e327b891 100644
--- a/swift/obj/updater.py
+++ b/swift/obj/updater.py
@@ -86,15 +86,15 @@ class BucketizedUpdateSkippingLimiter(object):
The iterator increments stats as follows:
- * The `deferrals` stat is incremented for each update that is
- rate-limited. Note that a individual update is rate-limited at most
- once.
- * The `skips` stat is incremented for each rate-limited update that is
- not eventually yielded. This includes updates that are evicted from the
- deferral queue and all updates that remain in the deferral queue when
- ``drain_until`` time is reached and the iterator terminates.
- * The `drains` stat is incremented for each rate-limited update that is
- eventually yielded.
+ * The `deferrals` stat is incremented for each update that is
+ rate-limited. Note that a individual update is rate-limited at most
+ once.
+ * The `skips` stat is incremented for each rate-limited update that is
+ not eventually yielded. This includes updates that are evicted from the
+ deferral queue and all updates that remain in the deferral queue when
+ ``drain_until`` time is reached and the iterator terminates.
+ * The `drains` stat is incremented for each rate-limited update that is
+ eventually yielded.
Consequently, when this iterator terminates, the sum of `skips` and
`drains` is equal to the number of `deferrals`.
@@ -219,12 +219,12 @@ class SweepStats(object):
"""
Stats bucket for an update sweep
- A measure of the rate at which updates are being rate-limited is:
+ A measure of the rate at which updates are being rate-limited is::
deferrals / (deferrals + successes + failures - drains)
A measure of the rate at which updates are not being sent during a sweep
- is:
+ is::
skips / (skips + successes + failures)
"""