Document that pre_spawn_hook maybe a coroutine

This commit is contained in:
yuvipanda
2018-11-02 17:19:16 -07:00
parent cff066a7be
commit 1efb8c765b

View File

@@ -516,11 +516,14 @@ class Spawner(LoggingConfigurable):
pre_spawn_hook = Any(
help="""
An optional hook function that you can implement to do some bootstrapping work before
the spawner starts. For example, create a directory for your user or load initial content.
An optional hook function that you can implement to do some
bootstrapping work before the spawner starts. For example, create a
directory for your user or load initial content.
This can be set independent of any concrete spawner implementation.
This maybe a coroutine.
Example::
from subprocess import check_call