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

ExceptionGroup.exceptions does not show up in documentation #356

Closed
SyntaxColoring opened this issue Aug 10, 2021 · 3 comments
Closed

ExceptionGroup.exceptions does not show up in documentation #356

SyntaxColoring opened this issue Aug 10, 2021 · 3 comments
Labels
bug Something isn't working documentation Requires additions or changes to the documentation

Comments

@SyntaxColoring
Copy link

It seems like the exceptions attribute of the ExceptionGroup class is intended to be publicly documented. See #141 (comment) and commit cd4d0bc.

However, despite this doc comment being in the source:

#: the sequence of exceptions raised together
exceptions: Sequence[BaseException]

Nothing shows up on https://anyio.readthedocs.io/en/stable/api.html#anyio.ExceptionGroup.

Screen Shot 2021-08-10 at 12 30 28 PM

I tried building the docs locally from source and got the same problem. I can't figure out why. Maybe some kind of Sphinx misconfiguration?

@SyntaxColoring
Copy link
Author

SyntaxColoring commented Aug 10, 2021

I've only skimmed it so I'm not sure, but maybe sphinx-doc/sphinx#4534 is relevant?

@agronholm agronholm added bug Something isn't working documentation Requires additions or changes to the documentation labels Aug 10, 2021
@agronholm
Copy link
Owner

The related PR has been merged, so it doesn't seem that way. I'll look into fixing this manually. Thanks for pointing it out.

@agronholm
Copy link
Owner

This probably happened because exceptions was just an annotation that doesn't set any value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Requires additions or changes to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants