Skip to content

Commit 557cd59

Browse files
committed
Improve default_power_level_content_override documentation
1 parent 5884f0a commit 557cd59

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

changelog.d/17451.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Improve documentation on `default_power_level_content_override`.

docs/usage/configuration/config_documentation.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4134,6 +4134,38 @@ default_power_level_content_override:
41344134
trusted_private_chat: null
41354135
public_chat: null
41364136
```
4137+
4138+
The default power levels for each preset are:
4139+
```yaml
4140+
"m.room.name": 50
4141+
"m.room.power_levels": 100
4142+
"m.room.history_visibility": 100
4143+
"m.room.canonical_alias": 50
4144+
"m.room.avatar": 50
4145+
"m.room.tombstone": 100
4146+
"m.room.server_acl": 100
4147+
"m.room.encryption": 100
4148+
```
4149+
4150+
So a complete example where the default power-levels for a preset are maintained
4151+
but the power level for a new key is set is:
4152+
```yaml
4153+
default_power_level_content_override:
4154+
private_chat:
4155+
events:
4156+
"com.example.foo": 0
4157+
"m.room.name": 50
4158+
"m.room.power_levels": 100
4159+
"m.room.history_visibility": 100
4160+
"m.room.canonical_alias": 50
4161+
"m.room.avatar": 50
4162+
"m.room.tombstone": 100
4163+
"m.room.server_acl": 100
4164+
"m.room.encryption": 100
4165+
trusted_private_chat: null
4166+
public_chat: null
4167+
```
4168+
41374169
---
41384170
### `forget_rooms_on_leave`
41394171

synapse/handlers/room.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,6 +1188,8 @@ async def create_event(
11881188
)
11891189
events_to_send.append((power_event, power_context))
11901190
else:
1191+
# Please update the docs for `default_power_level_content_override` when
1192+
# updating the `events` dict below
11911193
power_level_content: JsonDict = {
11921194
"users": {creator_id: 100},
11931195
"users_default": 0,

0 commit comments

Comments
 (0)