summary refs log tree commit diff
path: root/docs/code_style.md
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2021-03-30 12:12:44 +0100
committerGitHub <noreply@github.com>2021-03-30 12:12:44 +0100
commitf02663c4ddfa259c96aebde848a83156540c9fb3 (patch)
tree00667a26bc8f9cbda98a3ea0f6d6312476489f34 /docs/code_style.md
parentMake RateLimiter class check for ratelimit overrides (#9711) (diff)
downloadsynapse-f02663c4ddfa259c96aebde848a83156540c9fb3.tar.xz
Replace `room_invite_state_types` with `room_prejoin_state` (#9700)
`room_invite_state_types` was inconvenient as a configuration setting, because
anyone that ever set it would not receive any new types that were added to the
defaults. Here, we deprecate the old setting, and replace it with a couple of
new settings under `room_prejoin_state`.
Diffstat (limited to 'docs/code_style.md')
-rw-r--r--docs/code_style.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/code_style.md b/docs/code_style.md
index 190f8ab2de..28fb7277c4 100644
--- a/docs/code_style.md
+++ b/docs/code_style.md
@@ -128,6 +128,9 @@ Some guidelines follow:
     will be if no sub-options are enabled).
 -   Lines should be wrapped at 80 characters.
 -   Use two-space indents.
+-   `true` and `false` are spelt thus (as opposed to `True`, etc.)
+-   Use single quotes (`'`) rather than double-quotes (`"`) or backticks
+    (`` ` ``) to refer to configuration options.
 
 Example: