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

redis.Redis is no longer documented, only redis.client.redis #1839

Closed
Zac-HD opened this issue Dec 29, 2021 · 3 comments · Fixed by #1841
Closed

redis.Redis is no longer documented, only redis.client.redis #1839

Zac-HD opened this issue Dec 29, 2021 · 3 comments · Fixed by #1841

Comments

@Zac-HD
Copy link

Zac-HD commented Dec 29, 2021

We noticed this because the docs build for Hypothesis now warns that our intersphinx link to redis.Redis no longer resolves.

Is this change intentional and importing from redis.client now best-practice? If so, a mention in the release notes would be helpful! If not, it would be great to document the shorter alias again 😁

@chayim
Copy link
Contributor

chayim commented Dec 29, 2021

@Zac-HD just to make sure is this the project? redis.Redis is definitely the right thing to import, though the files have been in redis.client for ... as long as I've been involved.

It looks like by expanding documentation for 4.1.0 we inadvertently broke yours. Can you pass me a link - or something we can look at?

@Zac-HD
Copy link
Author

Zac-HD commented Dec 29, 2021

That's right; this docstring ends up on this page of our docs (and here's a failing CI build).

Sounds like this is just a Sphinx config thing then; changing .. autoclass:: redis.client.Redis to .. autoclass:: redis.Redis might even be sufficient?

@chayim
Copy link
Contributor

chayim commented Dec 30, 2021

@Zac-HD Perfect, thank you for the pointers. Unfortunately this would be going into master so it would appear in latest rather that stable. I'll cross-link the PR that closes this.

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

Successfully merging a pull request may close this issue.

2 participants