Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Rework alias and public room list rules docs #16541

Merged
merged 2 commits into from
Oct 24, 2023
Merged

Conversation

DMRobertson
Copy link
Contributor

@DMRobertson DMRobertson commented Oct 23, 2023

This at least makes it easier for admins to deal with situations like those described in #15722.

Preview: https://pr16541--synapse-docs-previews.netlify.app/usage/configuration/config_documentation#alias_creation_rules

cc @xaur —please let me know if you think this wording is an improvement.

This at least makes it easier for admins to deal with situations like #15722.
@xaur
Copy link

xaur commented Oct 23, 2023

@DMRobertson this wording is a huge improvement. Appreciate explicit statements about the defaults (permit all) and that an empty list denies all. Also, I didn't know that alias_creation_rules: is not an empty list without []. Good to have more examples, too.

@DMRobertson
Copy link
Contributor Author

DMRobertson commented Oct 23, 2023

Also, I didn't know that alias_creation_rules: is not an empty list without [].

For completeness: the yaml document as a whole is parsed as a mapping (python: dictionary). So alias_creation_rules: ... is a key-value pair in this map. The value in this case is a YAML null (python: None)

>>> import yaml
>>> yaml.safe_load("alias_creation_rules:")
{'alias_creation_rules': None}```

@DMRobertson DMRobertson merged commit 6ec9881 into develop Oct 24, 2023
35 checks passed
@DMRobertson DMRobertson deleted the dmr/rules-docs branch October 24, 2023 12:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants