aio-pika icon indicating copy to clipboard operation
aio-pika copied to clipboard

Documentation is missing a lot of essential functions.

Open fake-name opened this issue 7 months ago • 0 comments

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.

fake-name avatar Jul 09 '24 07:07 fake-name