Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

__doc__ no longer contains the traitlets help string for reference type traitlets (Dict, List, ...) #869

Closed
consideRatio opened this issue Sep 26, 2023 · 2 comments

Comments

@consideRatio
Copy link

consideRatio commented Sep 26, 2023

https://github.com/jupyterhub/autodoc_traits is a project that help generate documentation for sphinx by inspecting traitlets. Since #818 was merged and released in 5.10.0, it has experienced issues detecting traitlets help strings via a __doc__ attribute for some traitlet types.

Specifically the help string is no longer found in __doc__ attribute of the traitlet types Dict, List, Instance, and Command traitlets, but it still is found for the traitlet types Bool, Integer, Unicode. Maybe this is relating to reference/value type differences?

I've opened jupyterhub/autodoc-traits#55 about it, but since I'm unsure if its a bug in this project or autodoc_traits at this point, I'm opening this issue as well for now.

@blink1073
Copy link
Contributor

I tried the autodoc test suite with traitlets@5.10.0 and was able to reproduce the failures. With 5.10.1 all the tests pass:

======================================== 16 passed in 6.05s ========================================

@consideRatio
Copy link
Author

Thank you @blink1073 !!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants