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

autodocs for enums generate crazy output #190

Open

ojii opened this issue Aug 15, 2024 · 2 comments · May be fixed by #191

Contributor

ojii commented Aug 15, 2024

see https://aiodynamo.readthedocs.io/en/latest/usage.html#aiodynamo.models.ReturnValues

Contributor

dimaqq commented Aug 15, 2024

Here's what we do:

https://github.com/canonical/operator/blob/449793f9867eba11dc2e7e1c28ea3dca1e1da231/ops/pebble.py#L1507-L1537

And here's the output

https://ops.readthedocs.io/en/latest/#ops.pebble.ChangeStatus

Contributor Author

ojii commented Aug 15, 2024

I don't want this part: (value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None), it's super confusing

ojii linked a pull request

that will close this issue

manually document enums #191

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment