Skip to content

Commit 619181a

Browse files
committed
maj doc
1 parent e94cc5b commit 619181a

File tree

1 file changed

+33
-32
lines changed

1 file changed

+33
-32
lines changed

docs/source/commands.rst

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
📚 Bot Documentation
2-
====================
1+
Commands
2+
========
33

44
🔧 General Commands
55
-------------------
@@ -8,19 +8,20 @@
88
99
/help
1010
11-
📖 Affiche la liste complète des commandes disponibles avec une explication pour chacune.
11+
📖 Displays a complete list of available commands with explanations for each.
1212

1313
.. code:: slash
1414
1515
/presentation
1616
17-
🤖 Présente le bot dans le serveur, puis permet à l’utilisateur de suggérer un nom en message privé. Toutes les suggestions sont sauvegardées dans un fichier.
17+
🤖 Introduces the bot in the server and invites users to suggest a name via DM.
18+
All suggestions are saved to a file.
1819

1920
.. code:: slash
2021
2122
/rules
2223
23-
📏 Affiche les règles d’utilisation du bot.
24+
📏 Displays the bot usage rules.
2425

2526
🎯 Prediction Commands
2627
----------------------
@@ -29,27 +30,27 @@
2930
3031
/pronos_course premier: str deuxieme: str troisieme: str best_lap: str
3132
32-
🏁 Envoie ou modifie tes pronostics pour la **course** (top 3 + meilleur tour).
33-
➡️ Une seule modification possible, **uniquement lorsque la session est ouverte**.
33+
🏁 Submit or update your **race predictions** (top 3 + fastest lap).
34+
➡️ Can only be changed **once**, and **only while the session is open**.
3435

3536
.. code:: slash
3637
3738
/pronos_qualif premier: str deuxieme: str troisieme: str
3839
39-
⏱️ Envoie ou modifie tes pronostics pour les **qualifications** (top 3 uniquement).
40-
➡️ Une seule modification possible, **uniquement lorsque la session est ouverte**.
40+
⏱️ Submit or update your **qualifying predictions** (top 3 only).
41+
➡️ Can only be changed **once**, and **only while the session is open**.
4142

4243
.. code:: slash
4344
4445
/visualisation
4546
46-
🔍 Affiche tes pronostics actuels, à la fois pour la course et les qualifications si disponibles.
47+
🔍 Displays your current predictions (race and qualifying if available).
4748

4849
.. code:: slash
4950
5051
/leaderboard
5152
52-
🏆 Affiche le **classement général** basé sur la précision des pronostics de tous les membres.
53+
🏆 Displays the **overall leaderboard** based on prediction accuracy.
5354

5455
🛡️ Admin Commands
5556
------------------
@@ -58,60 +59,60 @@
5859
5960
/clear nombre: int
6061
61-
🧹 Supprime un nombre défini de messages dans le salon actuel.
62-
🔒 **Réservé aux administrateurs.**
62+
🧹 Deletes a specific number of messages in the current channel.
63+
🔒 **Admins only.**
6364

6465
.. code:: slash
6566
66-
/admin_ban member: @membre reason: str article: str
67+
/admin_ban member: @member reason: str article: str
6768
68-
🔨 Bannit un membre en précisant la raison et l’article du règlement violé.
69-
🔒 **Réservé aux administrateurs.**
69+
🔨 Bans a member, specifying the reason and rule/article violated.
70+
🔒 **Admins only.**
7071

7172
.. code:: slash
7273
7374
/admin_open duration: float
7475
75-
🟢 Ouvre manuellement une session de pronostics pendant une durée définie (en heures).
76-
⚠️ Disponible uniquement en **mode manuel**.
76+
🟢 Manually opens a prediction session for a given duration (in hours).
77+
⚠️ Available in **manual mode only**.
7778

7879
.. code:: slash
7980
8081
/admin_close
8182
82-
🔴 Ferme la session de pronostics actuelle.
83-
⚠️ Disponible uniquement en **mode manuel**.
83+
🔴 Manually closes the current prediction session.
84+
⚠️ Available in **manual mode only**.
8485

8586
.. code:: slash
8687
8788
/admin_status
8889
89-
📊 Affiche le mode actuel du bot : **manuel** ou **automatique**.
90+
📊 Displays the current bot mode: **manual** or **automatic**.
9091

9192
.. code:: slash
9293
9394
/admin_stop
9495
95-
Interrompt le mode automatique et repasse en **mode manuel**.
96-
🔒 **Réservé aux administrateurs.**
96+
Stops automatic mode and switches to **manual mode**.
97+
🔒 **Admins only.**
9798

9899
.. code:: slash
99100
100101
/admin_launch
101102
102-
🚀 Active le **mode automatique** : les sessions seront ouvertes et fermées selon le calendrier F1.
103+
🚀 Starts the bot in **automatic mode**: sessions will open and close based on the F1 calendar.
103104

104105
.. code:: slash
105106
106107
/admin_getresult
107108
108-
🔄 Récupère manuellement les résultats d’une session via l’API FastF1 et met à jour le leaderboard.
109+
🔄 Manually fetches results from the FastF1 API and updates the leaderboard.
109110

110111
.. code:: slash
111112
112113
/session saison: int location: str type: str
113114
114-
🗂️ Configure manuellement une session de pronostics (`type = Q` ou `R`) puis met à jour le classement.
115+
🗂️ Manually configures a prediction session (`type = Q` for qualifying or `R` for race) and updates the leaderboard.
115116

116117
🛠️ Developer / System Commands
117118
------------------------------
@@ -120,13 +121,13 @@
120121
121122
!sync
122123
123-
🧩 Commande **non-slash** réservée aux développeurs (`owners_id`).
124-
Synchronise toutes les commandes slash avec Discord.
124+
🧩 **Non-slash command** reserved for developers (`owners_id`).
125+
Synchronizes all slash commands with Discord.
125126

126127
📌 Notes
127128
--------
128129

129-
- 🔐 **Les commandes admin nécessitent les permissions adéquates** (ex. : administrateur, bannir des membres…).
130-
- ⏱️ Le système de pronostics fonctionne en **mode manuel** ou **automatique**.
131-
- 🕒 Les sessions sont limitées dans le temps, selon le mode sélectionné.
132-
- ⚙️ Le bot utilise des `try/except` pour capturer les erreurs et génère des logs pour chaque action importante.
130+
- 🔐 **Admin commands require appropriate permissions** (e.g., administrator, ban members...).
131+
- ⏱️ The prediction system works in both **manual** and **automatic** modes.
132+
- 🕒 Sessions are time-limited depending on the selected mode.
133+
- ⚙️ Errors are handled using `try/except`, and logs are generated accordingly.

0 commit comments

Comments
 (0)