1 files changed, 3 insertions, 0 deletions

diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py

index 611d8a5cf7..e79f058e85 100644
--- a/synapse/module_api/__init__.py
+++ b/synapse/module_api/__init__.py
@@ -579,6 +579,9 @@ class ModuleApi:
     ) -> str:
         """Map a username onto a string suitable for a MXID
 
+        This follows the algorithm laid out at
+        https://matrix.org/docs/spec/appendices.html#mapping-from-other-character-sets.
+
         Added in Synapse v1.58.0
 
         Args: