Fixed #45

Added docstrings to "settings" module.
Updated `Enemy.__init__` documentation to avoid misunderstanding of `health` attribute.
Applied minor changes to game overview section in "challenge" document.

Signed-off-by: Serhii Horodilov <sgorodil@gmail.com>

Author: shorodilov

src/wtk/challenge.rst

@@ -2,10 +2,11 @@
                          Wizards, Thieves and Knights
 ###############################################################################
 
-"Wizards, Thieves and Knights" (WTK) game is a "Paper, Rock and Scissors" clone
-but in a fantasy setting. It comes with a simple command line interface where
-the use must type in his or her choice. The enemy is controlled by the script.
-The player's goal is to gain as many score points, as it possible.
+"Wizards, Thieves and Knights" (:abbr:`WTK (Wizards, Thieves and Knights)`)
+game is a "Paper, Rock and Scissors" clone but in a fantasy setting. It comes
+with a simple command line interface where the use must type in his or her
+choice. The enemy is controlled by the script. The player's goal is to gain
+as many score points, as it possible.
 
 *****************
 Code organization
@@ -118,29 +119,22 @@ Settings module contains constants values for the game.
 
 For example,
 
-.. py:data:: INITIAL_PLAYER_NAME
-
-    Initial health meter value for a player instance
-
-    :type: int
-
-.. py:data:: INITIAL_ENEMY_LEVEL
-
-    Indicates the level to initialize the first enemy instance.
-
-    :type: int
-
-.. py:data:: SCORE_SUCCESS_ATTACK
-
-    Set the score value to assign when an attack is successful
-
-    :type: int
-
-.. py:data:: SCORE_ENEMY_DOWN
-
-    Set the score value to assign when an enemy is defeated
-
-    :type: int
+.. autodata:: wtk.settings.INITIAL_PLAYER_HEALTH
+    :no-value:
+.. autodata:: wtk.settings.INITIAL_ENEMY_LEVEL
+    :no-value:
+.. autodata:: wtk.settings.SCORE_SUCCESS_ATTACK
+    :no-value:
+.. autodata:: wtk.settings.SCORE_ENEMY_DOWN
+    :no-value:
+
+You may also define messages with this module, for example:
+
+.. autodata:: wtk.settings.MSG_SUCCESS_ATTACK
+.. autodata:: wtk.settings.MSG_SUCCESS_DEFENCE
+.. autodata:: wtk.settings.MSG_FAILURE_ATTACK
+.. autodata:: wtk.settings.MSG_FAILURE_DEFENCE
+.. autodata:: wtk.settings.MSG_DRAW
 
 ******
 Engine

src/wtk/models.py

@@ -49,6 +49,8 @@ def __init__(self, level: int = settings.INITIAL_ENEMY_LEVEL) -> None:
         """
         Initialize instance
 
+        Health value is equal to the level value.
+
         :param level: an enemy's level indicator
         :type level: int
 

src/wtk/settings.py

@@ -7,16 +7,61 @@
 GAME_TITLE = "KNIGHT, THIEFS AND WIZARDS GAME"
 
 # initial settings
-INITIAL_PLAYER_HEALTH = 5
-INITIAL_ENEMY_LEVEL = 1
+INITIAL_PLAYER_HEALTH: int = 5
+"""
+Initial player health value
+
+:type INITIAL_PLAYER_HEALTH: int
+"""
+INITIAL_ENEMY_LEVEL: int = 1
+"""
+Initial enemy level value
+
+:type INITIAL_ENEMY_LEVEL: int
+"""
 
 # score assignment options
-SCORE_SUCCESS_ATTACK = 1
-SCORE_ENEMY_DOWN = 5
+SCORE_SUCCESS_ATTACK: int = 1
+"""
+Score points value to assign when player's attack is successful
+
+:type SCORE_SUCCESS_ATTACK: int
+"""
+SCORE_ENEMY_DOWN: int = 5
+"""
+Score points value to assign when enemy is defeated
+
+:type SCORE_ENEMY_DOWN: int
+"""
 
 # messages
-MSG_SUCCESS_ATTACK = "YOUR ATTACK IS SUCCESSFUL!"
-MSG_SUCCESS_DEFENCE = "YOUR DEFENCE IS SUCCESSFUL!"
-MSG_FAILURE_ATTACK = "YOUR ATTACK IS FAILED!"
-MSG_FAILURE_DEFENCE = "YOUR DEFENCE HAS BEEN BREACHED!"
-MSG_DRAW = "IT'S A DRAW!"
+MSG_SUCCESS_ATTACK: str = "YOUR ATTACK IS SUCCESSFUL!"
+"""
+Successful attack message
+
+:type MSG_SUCCESS_ATTACK: str
+"""
+MSG_SUCCESS_DEFENCE: str = "YOUR DEFENCE IS SUCCESSFUL!"
+"""
+Successful defence message
+
+:type MSG_SUCCESS_DEFENCE: str
+"""
+MSG_FAILURE_ATTACK: str = "YOUR ATTACK IS FAILED!"
+"""
+Failed attack message
+
+:type MSG_FAILURE_ATTACK: str
+"""
+MSG_FAILURE_DEFENCE: str = "YOUR DEFENCE HAS BEEN BREACHED!"
+"""
+Failed defence message
+
+:type MSG_FAILURE_DEFENCE: str
+"""
+MSG_DRAW: str = "IT'S A DRAW!"
+"""
+Draw fight message
+
+:type MSG_DRAW: str
+"""