Adding information in connection pool class doc string for available SSLConnection class, that can be used for SSL connectionss by petyaslavova · Pull Request #3710 · redis/redis-py (original) (raw)
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.