Skip to content

Commit eca43f1

Browse files
committed
docs: add docstrings to legacy web request handlers
1 parent f3d5eb8 commit eca43f1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

nbgitpuller/handlers.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,12 @@ async def get(self):
177177

178178

179179
class LegacyGitSyncRedirectHandler(IPythonHandler):
180+
"""
181+
The /git-pull endpoint was previously exposed /git-sync.
182+
183+
For backward compatibility we keep listening to the /git-sync endpoint but
184+
respond with a redirect to the /git-pull endpoint.
185+
"""
180186
@web.authenticated
181187
async def get(self):
182188
new_url = '{base}git-pull?{query}'.format(
@@ -187,6 +193,12 @@ async def get(self):
187193

188194

189195
class LegacyInteractRedirectHandler(IPythonHandler):
196+
"""
197+
The /git-pull endpoint was previously exposed /interact.
198+
199+
For backward compatibility we keep listening to the /interact endpoint but
200+
respond with a redirect to the /git-pull endpoint.
201+
"""
190202
@web.authenticated
191203
async def get(self):
192204
repo = self.get_argument('repo')

0 commit comments

Comments
 (0)