From aae77da73ffc89c31d0b17fa8ce5d8b58605de63 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 18 Jan 2018 17:11:20 +0000
Subject: [PATCH] Fixup comments
---
synapse/config/repository.py | 6 +++++-
synapse/rest/media/v1/storage_provider.py | 4 ++--
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/synapse/config/repository.py b/synapse/config/repository.py
index 81db0193fb..8bbc16ba40 100644
--- a/synapse/config/repository.py
+++ b/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
+ ),
)
diff --git a/synapse/rest/media/v1/storage_provider.py b/synapse/rest/media/v1/storage_provider.py
index 0074d2d426..9bf88f01f9 100644
--- a/synapse/rest/media/v1/storage_provider.py
+++ b/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"])
--
GitLab