summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2020-05-27 13:34:46 +0100
committerErik Johnston <erik@matrix.org>2020-05-27 13:34:46 +0100
commitd7d8a2e7ee5058ebc9ce16ca10ecba3e4b1f8928 (patch)
tree95690348a0a065cd9e4a8336d38abb837df1256b
parentFix specifying cache factors via env vars with * in name. (#7580) (diff)
downloadsynapse-d7d8a2e7ee5058ebc9ce16ca10ecba3e4b1f8928.tar.xz
Fix up comments
-rw-r--r--docs/sample_config.yaml2
-rw-r--r--synapse/config/cache.py4
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 48f273b0b2..0ec482719d 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -647,7 +647,7 @@ caches:
    # alphanumeric or underscores. These caches can be named with or
    # without the special characters stripped. For example, to specify
    # the cache factor for `*stateGroupCache*` via an environment
-   # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2`.
+   # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2.0`.
    #
    per_cache_factors:
      #get_users_who_share_room_with_user: 2.0
diff --git a/synapse/config/cache.py b/synapse/config/cache.py
index acc31652de..0672538796 100644
--- a/synapse/config/cache.py
+++ b/synapse/config/cache.py
@@ -46,7 +46,7 @@ def _canonicalise_cache_name(cache_name: str) -> str:
 
     Since we specify cache names in config and environment variables we need to
     ignore case and special characters. For example, some caches have asterisks
-    in their name to donate that they're not attached to a particular database
+    in their name to denote that they're not attached to a particular database
     function, and these asterisks need to be stripped out
     """
 
@@ -130,7 +130,7 @@ class CacheConfig(Config):
            # alphanumeric or underscores. These caches can be named with or
            # without the special characters stripped. For example, to specify
            # the cache factor for `*stateGroupCache*` via an environment
-           # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2`.
+           # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2.0`.
            #
            per_cache_factors:
              #get_users_who_share_room_with_user: 2.0