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

Documentation is missing a lot of essential functions. #635

Open
fake-name opened this issue Jul 9, 2024 · 0 comments
Open

Documentation is missing a lot of essential functions. #635

fake-name opened this issue Jul 9, 2024 · 0 comments

Comments

@fake-name
Copy link

I was trying to figure out how to configure timeouts for a channel. Apparently this is done via channel.set_qos(), but that function does not exist in the documentation (https://aio-pika.readthedocs.io/en/latest/apidoc.html#aio_pika.Connection.channel).

I believe this is because the autodoc generator is configured to ONLY include functions where there is a docstring. Thats fine if you have docstrings for everything but internal functions, but that's obviously not an accurate description here.

I think this should be as simple as adding :undoc-members: to all the classes/module entries in https://github.com/mosquito/aio-pika/blob/master/docs/source/apidoc.rst.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant