Fix docs on record_action to clarify the actions are applied (#17426)

This looks like a copy/paste error: the function doesn't reject anything, but instead allows the action count to go through regardless. The remainder of the function's documentation appears correct.
element-hq · Jul 11, 2024 · 677142b · 677142b
1 parent 342f0c3
commit 677142b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/changelog.d/17426.misc b/changelog.d/17426.misc
@@ -0,0 +1 @@
+Fix documentation on `RateLimiter#record_action`.
diff --git a/synapse/api/ratelimiting.py b/synapse/api/ratelimiting.py
@@ -236,9 +236,8 @@ def record_action(
             requester: The requester that is doing the action, if any.
             key: An arbitrary key used to classify an action. Defaults to the
                 requester's user ID.
-            n_actions: The number of times the user wants to do this action. If the user
-                cannot do all of the actions, the user's action count is not incremented
-                at all.
+            n_actions: The number of times the user performed the action. May be negative
+                to "refund" the rate limit.
             _time_now_s: The current time. Optional, defaults to the current time according
                 to self.clock. Only used by tests.
         """
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix documentation on `RateLimiter#record_action`.