Updated election_cycle init docstring.

2023-09-14 11:55:08 -04:00
parent fb909c009a
commit f70a7989ae
1 changed files with 5 additions and 6 deletions
@@ -20,16 +20,15 @@ class ElectionCycle:
    """

    def __init__(self, cycle: int, config: DakinyConfig, guild: nextcord.Guild) -> None:
-        # TODO update
        """
-        Generates all dates relevant to the election cycle from input election start, term start and end dates.
+        Generates all dates relevant to the election cycle determined by the config and cycle.

        Args:
-            election_start (datetime): Date the election cycle starts.
-            term_start (datetime): Date the term being elected starts.
-            term_end (datetime): Date the term being elected ends.
-            bot: the discord bot instance
+            cycle (int): Which election cycle this cycle is.
+            config (DakinyConfig): The entire config object.
+            guild (nextcord.Guild): The guild that this election is running in.
        """
+
        self.config: DakinyConfig = config
        self.cycle = cycle
        self.elecion_cycle = self.config.election_cycles[self.cycle]