Add info about shell expansion to cmd / args traitlets

We should probably standardize this too
This commit is contained in:
YuviPanda
2016-11-28 22:45:06 -08:00
parent 4f1f7d6b8f
commit b0dc52781e

View File

@@ -199,7 +199,6 @@ class Spawner(LoggingConfigurable):
""" """
).tag(config=True) ).tag(config=True)
# FIXME: Add info about shell expansion here.
cmd = Command( cmd = Command(
['jupyterhub-singleuser'], ['jupyterhub-singleuser'],
help=""" help="""
@@ -210,15 +209,19 @@ class Spawner(LoggingConfigurable):
This is usually set if you want to start the single-user server in a different python This is usually set if you want to start the single-user server in a different python
environment (with virtualenv/conda) than JupyterHub itself. environment (with virtualenv/conda) than JupyterHub itself.
Some spawners allow shell-style expansion here, allowing you to use environment variables.
Most, including the default, do not. Consult the documentation for your spawner to verify!
""" """
).tag(config=True) ).tag(config=True)
# FIXME: Add info about shell expansion here.
args = List( args = List(
Unicode(), Unicode(),
help=""" help="""
Extra arguments to be passed to the single-user server. Extra arguments to be passed to the single-user server.
Some spawners allow shell-style expansion here, allowing you to use environment variables here.
Most, including the default, do not. Consult the documentation for your spawner to verify!
""" """
).tag(config=True) ).tag(config=True)