Skip to content

Commit 6e07ba2

Browse files
author
Tarcisio Nunes
committed
fix docu
1 parent a29cb0a commit 6e07ba2

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

pyredis/client.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -571,6 +571,11 @@ class SentinelClient(object):
571571
:param sentinels:
572572
Accepts a list of sentinels in this form: [('sentinel1', 26379), ('sentinel2', 26379), ('sentinel3', 26379)]
573573
:type sentinels: list
574+
575+
:param password:
576+
Password used for authentication of Sentinel instance itself. If None, no authentication is done.
577+
Only available starting with Redis 5.0.1.
578+
:type password: str
574579
"""
575580
def __init__(self, sentinels, password=None):
576581
self._conn = None

pyredis/pool.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,11 @@ class SentinelHashPool(
451451
:param retries:
452452
In case a sentinel delivers stale data, how many other sentinels should be tried.
453453
:type retries: int
454+
455+
:param sentinel_password:
456+
Password used for authentication of Sentinel instance itself. If None, no authentication is done.
457+
Only available starting with Redis 5.0.1.
458+
:type sentinel_password: str
454459
"""
455460
def __init__(self, sentinels, buckets, slave_ok=False, retries=3, sentinel_password=None, **kwargs):
456461
super().__init__(**kwargs)
@@ -612,6 +617,11 @@ class SentinelPool(
612617
:param retries:
613618
In case a sentinel delivers stale data, how many other sentinels should be tried.
614619
:type retries: int
620+
621+
:param sentinel_password:
622+
Password used for authentication of Sentinel instance itself. If None, no authentication is done.
623+
Only available starting with Redis 5.0.1.
624+
:type sentinel_password: str
615625
"""
616626
def __init__(self, sentinels, name, slave_ok=False, retries=3, sentinel_password=None, **kwargs):
617627
super().__init__(**kwargs)

0 commit comments

Comments
 (0)