MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-11-10 20:11:32 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse source 
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.
This commit is contained in:
Travis Ralston 2024-07-11 07:03:13 -06:00 committed by GitHub
parent 342f0c35b7
commit 677142b6a9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/17426.misc Normal file
View file

@ -0,0 +1 @@
Fix documentation on `RateLimiter#record_action`.

5
synapse/api/ratelimiting.py
View file

@ -236,9 +236,8 @@ class Ratelimiter:
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.
"""