Update a docstring

matrix-org · Apr 19, 2021 · 17e6ff5 · 17e6ff5
1 parent d837408
commit 17e6ff5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/synapse/server.py b/synapse/server.py
@@ -287,7 +287,11 @@ def setup(self) -> None:
             self.setup_background_tasks()
 
     def start_listening(self) -> None:
-        """Start the HTTP, manhole, metrics, etc listeners"""
+        """Start the HTTP, manhole, metrics, etc listeners
+
+        Does nothing in this base class; overridden in derived classes to start the
+        appropriate listeners.
+        """
         pass
 
     def setup_background_tasks(self) -> None: