Fix rc_room_creation and rc_reports docs - remove per_user typo (#18998)

This commit is contained in:
Sebastian Spaeth
2025-09-30 22:17:11 +02:00
committed by GitHub
parent 5adb08f3c9
commit d1c96ee0f2
3 changed files with 9 additions and 12 deletions

1
changelog.d/18998.doc Normal file
View File

@@ -0,0 +1 @@
Fix documentation for `rc_room_creation` and `rc_reports` to clarify that a `per_user` rate limit is not supported.

View File

@@ -2006,9 +2006,8 @@ This setting has the following sub-options:
Default configuration: Default configuration:
```yaml ```yaml
rc_reports: rc_reports:
per_user: per_second: 1.0
per_second: 1.0 burst_count: 5.0
burst_count: 5.0
``` ```
Example configuration: Example configuration:
@@ -2031,9 +2030,8 @@ This setting has the following sub-options:
Default configuration: Default configuration:
```yaml ```yaml
rc_room_creation: rc_room_creation:
per_user: per_second: 0.016
per_second: 0.016 burst_count: 10.0
burst_count: 10.0
``` ```
Example configuration: Example configuration:

View File

@@ -2259,9 +2259,8 @@ properties:
Setting this to a high value allows users to report content quickly, possibly in Setting this to a high value allows users to report content quickly, possibly in
duplicate. This can result in higher database usage. duplicate. This can result in higher database usage.
default: default:
per_user: per_second: 1.0
per_second: 1.0 burst_count: 5.0
burst_count: 5.0
examples: examples:
- per_second: 2.0 - per_second: 2.0
burst_count: 20.0 burst_count: 20.0
@@ -2270,9 +2269,8 @@ properties:
description: >- description: >-
Sets rate limits for how often users are able to create rooms. Sets rate limits for how often users are able to create rooms.
default: default:
per_user: per_second: 0.016
per_second: 0.016 burst_count: 10.0
burst_count: 10.0
examples: examples:
- per_second: 1.0 - per_second: 1.0
burst_count: 5.0 burst_count: 5.0