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

PDoc fails with cryptic error message when misformatting Returns field in API documentation #399

Open
djgroen opened this issue Jul 7, 2023 · 0 comments
Open

PDoc fails with cryptic error message when misformatting Returns field in API documentation #399

djgroen opened this issue Jul 7, 2023 · 0 comments
Assignees
@djgroen
Labels
bug Something isn't working

Comments

@djgroen
Copy link
Contributor

djgroen commented Jul 7, 2023

I am currently trying to fix this, but the ValueError that pdoc throws is highly uninformative.

After adding print statements to my local pdoc installation I discovered this error occurs when the type is not specified in the Return field of the documentation, but only the description.

I am tagging @bartoszbosak on this for his awareness, as it was the QCG-related doc material that triggered this ;).
@djgroen djgroen added the bug Something isn't working label Jul 7, 2023
@djgroen djgroen self-assigned this Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@djgroen djgroen

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@djgroen