Browse Source

Fixup comments

Erik Johnston 6 years ago
parent
commit
aae77da73f
2 changed files with 7 additions and 3 deletions
  1. 5 1
      synapse/config/repository.py
  2. 2 2
      synapse/rest/media/v1/storage_provider.py

+ 5 - 1
synapse/config/repository.py

@@ -39,7 +39,11 @@ ThumbnailRequirement = namedtuple(
 )
 
 MediaStorageProviderConfig = namedtuple(
-    "MediaStorageProviderConfig", ("store_local", "store_remote", "store_synchronous",)
+    "MediaStorageProviderConfig", (
+        "store_local",  # Whether to store newly uploaded local files
+        "store_remote",  # Whether to store newly downloaded remote files
+        "store_synchronous",  # Whether to wait for successful storage for local uploads
+    ),
 )
 
 

+ 2 - 2
synapse/rest/media/v1/storage_provider.py

@@ -99,7 +99,7 @@ class FileStorageProviderBackend(StorageProvider):
 
     Args:
         hs (HomeServer)
-        config: The config returned by `parse_config`, i
+        config: The config returned by `parse_config`.
     """
 
     def __init__(self, hs, config):
@@ -133,7 +133,7 @@ class FileStorageProviderBackend(StorageProvider):
 
         The returned value is passed into the constructor.
 
-        In this case we only care about a single param, the directory, so lets
+        In this case we only care about a single param, the directory, so let's
         just pull that out.
         """
         return Config.ensure_directory(config["directory"])