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.

Sign up for GitHub

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

Jump to bottom

Pydantic code sometimes set a docstring to None #37

Closed
pawamoy opened this issue May 15, 2020 · 0 comments
Closed

Pydantic code sometimes set a docstring to None #37

pawamoy opened this issue May 15, 2020 · 0 comments
Labels
bug Something isn't working module:loader

Comments

@pawamoy
Copy link
Member

pawamoy commented May 15, 2020

Describe the bug
If a pydantic field doesn't have a docstring, the docstring is not set to "", making the parser fail.

To Reproduce
Try to build the documentation of pytkdocs. It will hang because of a combination of this issue and #36

Expected behavior
Docstring should always be a string.

Additional context
Maybe we could simply accept None in the parsers and return immediately if it's None, rather than making sure the docstring is always set to "" as default.
@pawamoy pawamoy added bug Something isn't working module:loader labels May 15, 2020
@pawamoy pawamoy mentioned this issue May 15, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working module:loader
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pawamoy