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

No reference to API documentation from github project / pypi homepage. #1021

Closed
fake-name opened this issue Aug 20, 2018 · 3 comments
Closed

Comments

@fake-name
Copy link

fake-name commented Aug 20, 2018

Basically, I was trying to find API documentation for ConnectionPool (the quickstart doesn't document how you release a connection you acquired from a pool).

Apparently, https://redis-py.readthedocs.io/en/latest/ is the documentation for this project, but I had to use google to get there.

It seems to me that the README at https://github.com/andymccurdy/redis-py and https://pypi.org/project/redis/ should probably have at least a reference to the generated autodocs.

@RoeyPrat
Copy link

Hi @fake-name, is this what you meant?

@fake-name
Copy link
Author

Spot on!

andymccurdy added a commit that referenced this issue Sep 26, 2018
@Grokzen
Copy link

Grokzen commented Oct 21, 2018

This issue could be closed after merge of #1026 @andymccurdy

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

4 participants