Skip to content

Adding information in connection pool class doc string for available SSLConnection class, that can be used for SSL connectionss #3710

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

petyaslavova
Copy link
Collaborator

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?

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

…SSLConnection class, that can be used for SSL connections
@petyaslavova petyaslavova added the maintenance Maintenance (CI, Releases, etc) label Jul 16, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.py to mention SSLConnection
  • Updated docstring in redis/asyncio/connection.py to mention SSLConnection

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.SSLConnection for 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.SSLConnection for 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Wrong: Redis-py 6.2.0 ssl=True does not exist (Named in documentation), it became connection_class=redis.SSLConnection
1 participant