added docstring

deltachat-bot · Aug 20, 2024 · 9c40e5f · 9c40e5f
1 parent 32faf3d
commit 9c40e5f
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/team_bot/bot.py b/src/team_bot/bot.py
@@ -268,7 +268,11 @@ def get_relay_group(self, outside_id: int) -> deltachat.Chat:
                 return self.account.get_chat_by_id(mapping[1])
         return None
 
-    def offboard(self, ex_admin):
+    def offboard(self, ex_admin: deltachat.Contact) -> None:
+        """Remove a former crew member from all relay groups they are part of.
+
+        :param ex_admin: a contact which just got removed from the crew.
+        """
         for mapping in self.kvstore.get("relays"):
             relay_group = self.account.get_chat_by_id(mapping[1])
             if ex_admin in relay_group.get_contacts():