docs: add docstrings to legacy web request handlers

jupyterhub · Jan 18, 2022 · 78203d8 · 78203d8
1 parent a0df524
commit 78203d8
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/nbgitpuller/handlers.py b/nbgitpuller/handlers.py
@@ -177,6 +177,12 @@ async def get(self):
 
 
 class LegacyGitSyncRedirectHandler(IPythonHandler):
+    """
+    The /git-pull endpoint was previously exposed /git-sync.
+
+    For backward compatibility we keep listening to the /git-sync endpoint but
+    respond with a redirect to the /git-pull endpoint.
+    """
     @web.authenticated
     async def get(self):
         new_url = '{base}git-pull?{query}'.format(
@@ -187,6 +193,12 @@ async def get(self):
 
 
 class LegacyInteractRedirectHandler(IPythonHandler):
+    """
+    The /git-pull endpoint was previously exposed /interact.
+
+    For backward compatibility we keep listening to the /interact endpoint but
+    respond with a redirect to the /git-pull endpoint.
+    """
     @web.authenticated
     async def get(self):
         repo = self.get_argument('repo')