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

Enumeration Members Without Docstring Do Not Get Rendered Anymore Since v12.2.0 #455

Closed
lovetheguitar opened this issue Nov 10, 2022 · 2 comments · Fixed by #457
Closed

Enumeration Members Without Docstring Do Not Get Rendered Anymore Since v12.2.0 #455

lovetheguitar opened this issue Nov 10, 2022 · 2 comments · Fixed by #457
Labels
bug

Comments

@lovetheguitar
Copy link

Problem Description

With pdoc==12.1.0 enumeration members are rendered nicely, with and without a docstring.
After upgrading to 12.2.0 all the enumarations get rendered as "empty classes", when not every single item has a docstring.

I saw #411 which seems to improve dataclass documentation but IMHO broke enumeration documentation.
@lovetheguitar lovetheguitar changed the title Enumerations Without Docstring Are Not Documented Anymore Since v12.2.0 Enumeration Members Without Docstring Do Not Get Rendered Anymore Since v12.2.0 Nov 10, 2022
mhils added a commit to mhils/pdoc that referenced this issue Nov 10, 2022
@mhils
fix mitmproxy#455
b34c482
mhils added a commit to mhils/pdoc that referenced this issue Nov 10, 2022
@mhils
fix mitmproxy#455
9647d0b
mhils added a commit to mhils/pdoc that referenced this issue Nov 10, 2022
@mhils
document enum members without docstring, fix mitmproxy#455
08c565c
@mhils mhils mentioned this issue Nov 10, 2022
Merged
@mhils
Copy link
Member

mhils commented Nov 10, 2022

Thanks for the report! 🍰 I'll ship a patch release with a fix. :)

mhils added a commit that referenced this issue Nov 10, 2022
@mhils
document enum members without docstring, fix #455 (#457)
c009473
@lovetheguitar
Copy link
Author

Thanks for the report! 🍰 I'll ship a patch release with a fix. :)

Very welcome. Thanks for the blazingly fast fix! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document enum mebers without docstring mhils/pdoc
2 participants
@mhils @lovetheguitar