element-hq / element-hq/synapse
Explain the rate limiting mechanism in the docs
Open
A-Docs
A-Rate-Limit
O-Occasional
T-Task
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 600
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 51
Description
The code has this very comprehensive docstring explaining the mechanism really well.
https://github.com/element-hq/synapse/blob/57efc8c03eb27048c721f389f0b56e7bea145be3/synapse/api/ratelimiting.py#L33-L69
Meanwhile, the docs for admins who are supposed to understand how to configure these settings, are completely devoid of an explanation of how the burst works.
https://github.com/element-hq/synapse/blob/57efc8c03eb27048c721f389f0b56e7bea145be3/docs/usage/configuration/config_documentation.md?plain=1#L1637-L1643
I think this could well be resolved by copying the relevant half from the docstring to the docs.
Contributor guide
Assessment
This issue has not been assessed yet.