diff options
| author | Jon Banafato <jon@jonafato.com> | 2020-07-24 17:55:33 -0400 |
|---|---|---|
| committer | Roey Prat <roey.prat@redislabs.com> | 2020-07-26 11:44:07 +0300 |
| commit | c6f13c3b69d32257ab75ba9d824e5b555f91572c (patch) | |
| tree | 3fcd1ae0cdb50bbef3a0bb414ec148720e152f4f /redis/sentinel.py | |
| parent | 20ec5d771d5116f51735b1d7912447e75c8c3d53 (diff) | |
| download | redis-py-c6f13c3b69d32257ab75ba9d824e5b555f91572c.tar.gz | |
Fix some documentation formatting
Fix a few broken links and class references, move a docstring, and fix a
code block.
Diffstat (limited to 'redis/sentinel.py')
| -rw-r--r-- | redis/sentinel.py | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/redis/sentinel.py b/redis/sentinel.py index 2b212ea..203c859 100644 --- a/redis/sentinel.py +++ b/redis/sentinel.py @@ -244,18 +244,20 @@ class Sentinel(object): """ Returns a redis client instance for the ``service_name`` master. - A SentinelConnectionPool class is used to retrive the master's - address before establishing a new connection. + A :py:class:`~redis.sentinel.SentinelConnectionPool` class is + used to retrive the master's address before establishing a new + connection. NOTE: If the master's address has changed, any cached connections to the old master are closed. - By default clients will be a redis.Redis instance. Specify a - different class to the ``redis_class`` argument if you desire - something different. + By default clients will be a :py:class:`~redis.Redis` instance. + Specify a different class to the ``redis_class`` argument if you + desire something different. - The ``connection_pool_class`` specifies the connection pool to use. - The SentinelConnectionPool will be used by default. + The ``connection_pool_class`` specifies the connection pool to + use. The :py:class:`~redis.sentinel.SentinelConnectionPool` + will be used by default. All other keyword arguments are merged with any connection_kwargs passed to this class and passed to the connection pool as keyword @@ -275,9 +277,9 @@ class Sentinel(object): A SentinelConnectionPool class is used to retrive the slave's address before establishing a new connection. - By default clients will be a redis.Redis instance. Specify a - different class to the ``redis_class`` argument if you desire - something different. + By default clients will be a :py:class:`~redis.Redis` instance. + Specify a different class to the ``redis_class`` argument if you + desire something different. The ``connection_pool_class`` specifies the connection pool to use. The SentinelConnectionPool will be used by default. |