docs(deltachat-rpc-client): document that 0 is a special value of set…

…_ephemeral_timer()
deltachat · Mar 18, 2024 · fcbbb91 · fcbbb91
1 parent c3a7fc4
commit fcbbb91
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/deltachat-rpc-client/src/deltachat_rpc_client/chat.py b/deltachat-rpc-client/src/deltachat_rpc_client/chat.py
@@ -84,7 +84,9 @@ def set_name(self, name: str) -> None:
         self._rpc.set_chat_name(self.account.id, self.id, name)
 
     def set_ephemeral_timer(self, timer: int) -> None:
-        """Set ephemeral timer of this chat."""
+        """Set ephemeral timer of this chat in seconds.
+
+        0 means the timer is disabled, use 1 for immediate deletion."""
         self._rpc.set_chat_ephemeral_timer(self.account.id, self.id, timer)
 
     def get_encryption_info(self) -> str: