style: change docstring style

Author: FlysonBot

.vscode/settings.json

@@ -6,22 +6,21 @@
         "-p",
         "test_*.py"
     ],
+    "pythonTestExplorer.testFramework": "pytest",
     "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true,
+    "python.testing.pytestArgs": [
+        "--doctest-modules",
+        "src"
+    ],
+    "python.testing.unittestEnabled": false,
     "[python]": {
         "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
             "source.organizeImports": "explicit"
         },
     },
-    "isort.args": [
-        "--profile",
-        "black"
-    ],
     "terminal.integrated.env.linux": {
         "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src"
-    },
-    "makefile.makefilePath": "docs/Makefile",
-    "makefile.configureOnOpen": false
+    }
 }

src/mastermind/core/models/game.py

@@ -9,8 +9,7 @@
 
 @dataclass
 class Game:
-    """
-    Dataclass for a game.
+    """Dataclass for a game.
 
     This class encapsulates all the essential information about a game, including the game board, configuration, entities, and current state.
 

src/mastermind/core/models/game_configuration.py

@@ -5,8 +5,7 @@
 
 @dataclass(frozen=True)
 class GameConfiguration:
-    """
-    Dataclass for the configuration of a game.
+    """Dataclass for the configuration of a game.
 
     This class defines the settings that determine how a game is structured, including the number of colors, dots, allowed attempts, and game mode.
 

src/mastermind/core/models/game_entities.py

@@ -6,8 +6,7 @@
 
 @dataclass(frozen=True)
 class GameEntities:
-    """
-    Dataclass for the entities of a game (such as players or those from plugins).
+    """Dataclass for the entities of a game (such as players or those from plugins).
 
     This class represents the key participants in a game, specifically the players involved in setting and breaking the code. It serves as a structured way to manage and reference these entities throughout the game's lifecycle.
 

src/mastermind/core/models/game_mode.py

@@ -4,8 +4,7 @@
 
 
 class GameMode(Enum):
-    """
-    Enum for the different game modes, which determined who is Player 1 and who is Player 2.
+    """Enum for the different game modes, which determined who is Player 1 and who is Player 2.
 
     Members:
         PVP: Player versus player mode.

src/mastermind/core/models/game_round.py

@@ -4,8 +4,7 @@
 
 @dataclass(frozen=True)
 class GameRound:
-    """
-    Dataclass for a single round of the game.
+    """ for a single round of the game.
 
     This class encapsulates the guess made during a round and the corresponding feedback received.
 

src/mastermind/core/models/game_state.py

@@ -6,8 +6,7 @@
 
 @dataclass
 class GameState:
-    """
-    Dataclass for maintaining the current state of the game, indicating whether the game has started, if it is over, and who won.
+    """Dataclass for maintaining the current state of the game, indicating whether the game has started, if it is over, and who won.
 
     Attributes:
         game_started (bool): A flag indicating if the game has started.

src/mastermind/core/models/gameboard.py

@@ -8,8 +8,7 @@
 
 @dataclass(frozen=True)
 class GameBoard:
-    """
-    Dataclass for the gameboard of a game.
+    """Dataclass for the gameboard of a game.
 
     This class represents the collection of game rounds that have taken place during a game session. It serves as a structured way to manage and track the progression of the game through its various rounds.
 
@@ -20,8 +19,7 @@ class GameBoard:
     game_rounds: Deque[GameRound]
 
     def __len__(self) -> int:
-        """
-        Returns the number of game rounds in the game board.
+        """Returns the number of game rounds in the game board.
 
         Returns:
             int: Number of game rounds in the game board.
@@ -35,8 +33,7 @@ def __len__(self) -> int:
 
     @property
     def guesses(self) -> Generator[Tuple[int, ...], None, None]:
-        """
-        Returns a generator of all guesses made in the game to allow for easy iteration.
+        """Returns a generator of all guesses made in the game to allow for easy iteration.
 
         Returns:
             Generator[Tuple[int, ...], None, None]: A generator of all guesses made in the game.
@@ -52,8 +49,7 @@ def guesses(self) -> Generator[Tuple[int, ...], None, None]:
 
     @property
     def feedbacks(self) -> Generator[Tuple[int, int], None, None]:
-        """
-        Returns a generator of all feedbacks received in the game to allow for easy iteration.
+        """Returns a generator of all feedbacks received in the game to allow for easy iteration.
 
         Yields:
             Generator[Tuple[int], None, None]: A generator of all feedbacks received in the game.