Closed manics closed 8 months ago
This isn't a KubeSpawner specific issue, it happens in dask/dask-gateway as well (https://github.com/dask/dask-gateway/issues/744)
There is a pattern to what help strings are missing - all config with the type Dict, List, Command. The underlying pattern for this could be that they relate to reference type and not value type variables perhaps.
Ah, and further, its an issue reproducing with traitlets 5.10.0, but not 5.9.0.
Resolved upstream in autodoc-traits, the latest page now renders correctly!
Bug description
Compare the traitlets help documentation in stable (6.0.0) https://jupyterhub-kubespawner.readthedocs.io/en/stable/spawner.html#kubespawner.KubeSpawner.extra_pod_config
with latest which has
No help string is provided
for some traitlets: https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.extra_pod_configHow to reproduce
https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.extra_pod_config
Expected behaviour
https://jupyterhub-kubespawner.readthedocs.io/en/stable/spawner.html#kubespawner.KubeSpawner.extra_pod_config / https://jupyterhub-kubespawner.readthedocs.io/en/6.0.0/spawner.html#kubespawner.KubeSpawner.extra_pod_config has help messages for the traitlets
Actual behaviour
No help string is provided
for some traitlets