Comments correction after review (matrix-org#2752)

docs/sample_config.yaml

@@ -2609,10 +2609,10 @@ redis:
 
 ## Oembed ##
 
-# Providers json files directory
-oembed_providers_dir: /etc/matrix-synapse/oembed/
-
+# Providers json files directory.
 # oembed directory contains https://oembed.com/providers.json file
 # that you can place in oembed_providers_dir. Deb package does that for you.
-# Other custom providers could be added in other .json files, following the
+# Other custom providers can be added in other .json files, following the
 # same json format.
+#
+oembed_providers_dir: /etc/matrix-synapse/oembed/

synapse/config/oembed.py

@@ -116,13 +116,13 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs):
         return """\
         ## Oembed ##
 
-        # Providers json files directory
-        oembed_providers_dir: /etc/matrix-synapse/oembed/
-
+        # Providers json files directory.
         # oembed directory contains https://oembed.com/providers.json file
         # that you can place in oembed_providers_dir. Deb package does that for you.
-        # Other custom providers could be added in other .json files, following the
+        # Other custom providers can be added in other .json files, following the
         # same json format.
+        #
+        oembed_providers_dir: /etc/matrix-synapse/oembed/
         """
 
 

tests/rest/media/v1/test_url_preview.py

@@ -79,7 +79,6 @@ def make_homeserver(self, reactor, clock):
 
         config["media_storage_providers"] = [provider_config]
 
-        # Route the HTTP version to an HTTP endpoint so that the tests work.
         config["oembed_providers_dir"] = os.path.join(os.environ["TOP"], "oembed")
 
         hs = self.setup_test_homeserver(config=config)