Adding information in connection pool class doc string for available SSLConnection class, that can be used for SSL connectionss#3710
Merged
petyaslavova merged 5 commits intomasterfrom Jul 23, 2025
Conversation
…SSLConnection class, that can be used for SSL connections
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds references to SSLConnection in the docstrings of both the synchronous and asyncio connection pool classes to document how to enable SSL connections.
- Updated docstring in
redis/connection.pyto mentionSSLConnection - Updated docstring in
redis/asyncio/connection.pyto mentionSSLConnection
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| redis/connection.py | Added doc entry for using SSLConnection |
| redis/asyncio/connection.py | Added doc entry for using SSLConnection |
Comments suppressed due to low confidence (2)
redis/connection.py:1318
- [nitpick] To match the existing style, consider rephrasing to something like: "Use :py:class:
~redis.SSLConnectionfor SSL-enabled connections."
:py:class:`~redis.SSLConnection` can be used for SSL enabled connections.
redis/asyncio/connection.py:1040
- [nitpick] For consistency and clarity in the asyncio module, you might reword to: "Use :py:class:
~redis.SSLConnectionfor SSL-enabled connections." and verify the import path if there's an async-specific SSLConnection class.
:py:class:`~redis.SSLConnection` can be used for SSL enabled connections.
vladvildanov
approved these changes
Jul 23, 2025
petyaslavova
added a commit
that referenced
this pull request
Jul 25, 2025
…SSLConnection class, that can be used for SSL connections (#3710)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request check-list
Please make sure to review and check all of these items:
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Description of change
Fixes #3694