doc: annotate get_custom_html docstring to keep in mind that Jinja is…

… involved
idiap · Nov 20, 2023 · 0132e54 · 0132e54
1 parent 375e890
commit 0132e54
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/multiauthenticator/multiauthenticator.py b/multiauthenticator/multiauthenticator.py
@@ -123,7 +123,11 @@ def check_blocked_users(self, username, authentication=None):
             self._authenticators.append(authenticator)
 
     def get_custom_html(self, base_url):
-        """Re-implementation generating one login button per configured authenticator"""
+        """Re-implementation generating one login button per configured authenticator
+
+        Note: the html generated in this method will be passed through Jinja's template
+        rendering, see the login implementation in JupyterHub's sources.
+        """
 
         html = []
         for authenticator in self._authenticators: