Docs: Add a note about client_setname and client_name difference (#2247)

redis · Jun 23, 2022 · d3a7a75 · d3a7a75
1 parent 6da8086
commit d3a7a75
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/redis/commands/core.py b/redis/commands/core.py
@@ -687,6 +687,12 @@ def client_setname(self, name: str, **kwargs) -> ResponseT:
         Sets the current connection name
 
         For more information see https://redis.io/commands/client-setname
+
+        .. note::
+           This method sets client name only for **current** connection.
+
+           If you want to set a common name for all connections managed
+           by this client, use ``client_name`` constructor argument.
         """
         return self.execute_command("CLIENT SETNAME", name, **kwargs)