document commands

Author: imperosol

src/commands/club.py

@@ -52,6 +52,12 @@ async def autocomplete_existing_club(
     async def club_infos(
         self, interaction: Interaction, club: Transform[ClubSchema, ClubTransformer]
     ):
+        """Récupère les informations sur un club à partir du site AE.
+
+        Args:
+            interaction:
+            club: le club dont on veut avoir les infos
+        """
         await interaction.response.defer(thinking=True)
         await interaction.followup.send(embed=self.club_service.embed(club))
 
@@ -63,6 +69,15 @@ async def remove_club_member(
         club: Transform[ClubSchema, ClubTransformer],
         member: Member,
     ):
+        """Retire un membre du club et le marque comme ancien membre.
+
+        Cette commande est accessible au président du club.
+
+        Args:
+            interaction:
+            club: le club d'où retirer le membre
+            member: le membre à retirer
+        """
         await interaction.response.defer(thinking=True)
         db_club = Club.get_or_none(Club.sith_id == club.id)
         if not db_club:
@@ -93,6 +108,14 @@ async def add_club_member(
         club: Transform[ClubSchema, ClubTransformer],
         member: Member,
     ):
+        """Ajoute un membre au club.
+        Cette commande est accessible au président du club.
+
+        Args:
+            interaction:
+            club: Le club dans lequel mettre l'utilisateur
+            member: L'utilisateur à rajouter
+        """
         await interaction.response.defer(thinking=True)
         db_club = Club.get_or_none(Club.sith_id == club.id)
         role_membre = member.guild.get_role(db_club.member_role_id)
@@ -121,6 +144,12 @@ async def add_club_member(
     async def create_club(
         self, interaction: Interaction, club: Transform[ClubSchema, ClubTransformer]
     ):
+        """Crée un club, avec ses salons, ses rôles et ses permissions.
+
+        Args:
+            interaction:
+            club: le club à créer
+        """
         await interaction.response.defer(thinking=True)
         if Club.filter(Club.sith_id == club.id).exists():
             await interaction.followup.send(f"Le club : {club.name} existe déjà...")
@@ -138,6 +167,15 @@ async def handover(
         new_president: Member,
         new_treasurer: Member,
     ):
+        """Change le responsable et le trésorier du club.
+        Si le club était inactif, il sera réactivé.
+
+        Args:
+            interaction:
+            club: le club pour lequel faire la passation
+            new_president: le nouveau président du club
+            new_treasurer: le nouveau trésorier du club
+        """
         await interaction.response.defer(thinking=True)
         db_club = Club.get_or_none(Club.sith_id == club.id)
         guild = interaction.guild
@@ -172,13 +210,18 @@ async def handover(
     async def stop_club(
         self, interaction: Interaction, club: Transform[ClubSchema, ClubTransformer]
     ):
+        """Désactive le club et retire tous ses membres.
+
+        Args:
+            interaction:
+            club: le club à désactiver
+        """
         await interaction.response.defer(thinking=True)
         db_club = Club.get_or_none(Club.sith_id == club.id)
         await self.club_service.stop_club(db_club, interaction.guild)
         annonce = await self.club_service.get_channel(
             interaction.guild, db_club.category_id, f"annonces {club.name}".lower()
         )
-
         if annonce:
             await annonce.send(
                 "Le club, n'ayant pas été repris, est "