Skip to content

Commit 1eb5887

Browse files
committed
Improve handler class docstrings
1 parent 39194fc commit 1eb5887

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

jupyter_server_proxy/handlers.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -587,10 +587,13 @@ def proxy(self, host, port, proxied_path):
587587

588588

589589
class NamedLocalProxyHandler(LocalProxyHandler):
590-
"""Maps a configured name to a local port or Unix socket path
590+
"""
591+
A tornado request handler that proxies HTTP and websockets from a port on
592+
the local system. The port is specified in config, and associated with a
593+
name which forms part of the URL.
591594
592595
Config will create a subclass of this for each named proxy. A further
593-
subclass below is used for named proxies where we also start
596+
subclass below is used for named proxies where we also start the server.
594597
"""
595598
port = 0
596599
mappath = {}
@@ -664,7 +667,13 @@ def options(self, path):
664667

665668
# FIXME: Move this to its own file. Too many packages now import this from nbrserverproxy.handlers
666669
class SuperviseAndProxyHandler(NamedLocalProxyHandler):
667-
'''Manage a given process and requests to it '''
670+
"""
671+
A tornado request handler that proxies HTTP and websockets from a local
672+
process which is launched on demand to handle requests. The command and
673+
other process options are specified in config.
674+
675+
A subclass of this will be made for each configured server process.
676+
"""
668677

669678
def __init__(self, *args, **kwargs):
670679
self.requested_port = 0

0 commit comments

Comments
 (0)