re

Author: TodoLodo

README.rst

@@ -57,22 +57,24 @@ Import module with its classes:
 
 .. _`logged in`:
 
-Login with your sso token
+Login with your sso token:
 
 .. code-block:: python
 
     api.login('Your sso token')
 
-You sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I),
-going to Applications > Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and
-copy the value
+Your sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I), going to Applications >
+Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and copy the value.
 
 .. _callofduty: https://my.callofduty.com/
 
 Game/Other sub classes
 ----------------------
-Following importation and initiation of the class ``API`` its associated subclasses can be called by ``API.subClassName``
-and following are available sub classes
+
+Following importation and initiation of the class ``API``, its associated subclasses can be called by
+``API.subClassName``.
+
+Below are the available sub classes:
 
 +-----------------+----------+
 | sub class       | catogery |
@@ -92,11 +94,11 @@ and following are available sub classes
 
 
 
-For a detailed description of each subclass, `__doc__` (docstring) of each sub class can be called as shown below:
+For a detailed description, ``__doc__`` (docstring) of each sub class can be called as shown below:
 
 .. _`ColdWar`:
 
-`ColdWar`
+``ColdWar``
 
 .. code-block:: python
 
@@ -109,7 +111,7 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 
 .. _`ModernWarfe`:
 
-`ModernWarfe`
+``ModernWarfe``
 
 .. code-block:: python
 
@@ -122,7 +124,7 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 
 .. _`Vanguard`:
 
-`Vanguard`
+``Vanguard``
 
 .. code-block:: python
 
@@ -135,7 +137,7 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 
 .. _`Warzone`:
 
-`Warzone`
+``Warzone``
 
 .. code-block:: python
 
@@ -148,7 +150,7 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 
 .. _`Me`:
 
-`Me`
+``Me``
 
 .. code-block:: python
 
@@ -161,7 +163,7 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 
 .. _`Misc`:
 
-`Misc`
+``Misc``:
 
 .. code-block:: python
 
@@ -175,16 +177,16 @@ For a detailed description of each subclass, `__doc__` (docstring) of each sub c
 Combat History
 --------------
 
-Any sub class of ``API``  of catogery game has methods to check a player's combat history.
-Note that before calling any methods of sub classes of ``API`` you must be `logged in`_.
+Any sub class of ``API``  that is of game catogery, has methods to check a player's combat history.
+Note that before calling any sub class methods of ``API`` you must be `logged in`_.
 Main methods are ``combatHistory()`` and ``combatHistoryWithDate()`` which are available for all ``ColdWar``,
 ``ModernWarfare``, ``Vanguard`` and ``Warzone`` classes.
 
-The ``combatHistory()`` takes 2 input parameteres which are platform and gamertag of type `cod_api.platforms`_ and
-string respectively
+The ``combatHistory()`` takes 2 input parameteres which are ``platform`` and ``gamertag`` of type `cod_api.platforms`_
+and string respectively.
 
 Here's an example for retrieving **Warzone** combat history of a player whose gamer tag is **Username#1234** on platform
-**Battlenet**
+**Battlenet**:
 
 .. code-block:: python
 
@@ -202,12 +204,14 @@ Here's an example for retrieving **Warzone** combat history of a player whose ga
     # printing results to console
     print(hist)
 
-The ``combatHistoryWithDate()`` takes 4 input parameteres which are platform, gamertag, start and end of type start and
-end parameters are utc timestamps in microseconds
+The ``combatHistoryWithDate()`` takes 4 input parameteres which are ``platform``, ``gamertag``, ``start`` and ``end`` of
+type `cod_api.platforms`_, string, int and int respectively.
+
+``start`` and ``end`` parameters are utc timestamps in microseconds.
 
 Here's an example for retrieving **ModernWarfare** combat history of a player whose gamer tag is **Username#1234567** on
 platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) and **1657949309**
-(Saturday, 16 July 2022 05:28:29)
+(Saturday, 16 July 2022 05:28:29):
 
 .. code-block:: python
 
@@ -230,11 +234,11 @@ details, where only the platform played on, game title, UTC timestamp, type ID,
 every match. And just like ``combatHistory()`` and ``combatHistoryWithDate()`` these methods are available for all
 ``ColdWar``, ``ModernWarfare``, ``Vanguard`` and ``Warzone`` classes.
 
-The ``breakdown()`` takes 2 input parameteres which are platform and gamertag of type `cod_api.platforms`_ and
-string respectively
+The ``breakdown()`` takes 2 input parameteres which are ``platform`` and ``gamertag`` of type `cod_api.platforms`_ and
+string respectively.
 
 Here's an example for retrieving **Warzone** combat history breakdown of a player whose gamer tag is **Username#1234**
-on platform **Battlenet**
+on platform **Battlenet**:
 
 .. code-block:: python
 
@@ -252,14 +256,14 @@ on platform **Battlenet**
     # printing results to console
     print(hist_b)
 
-The ``breakdownWithDate()`` takes 4 input parameteres which are platform, gamertag, start and end of type
-`cod_api.platforms`_, string, int and int respectively
+The ``breakdownWithDate()`` takes 4 input parameteres which are ``platform``, ``gamertag``, ``start`` and ``end`` of
+type `cod_api.platforms`_, string, int and int respectively.
 
-start and end parameters are utc timestamps in microseconds
+``start`` and ``end`` parameters are utc timestamps in microseconds.
 
 Here's an example for retrieving **ModernWarfare** combat history breakdown of a player whose gamer tag is
 **Username#1234567** on platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29)
-and **1657949309** (Saturday, 16 July 2022 05:28:29)
+and **1657949309** (Saturday, 16 July 2022 05:28:29):
 
 .. code-block:: python
 
@@ -280,17 +284,18 @@ and **1657949309** (Saturday, 16 July 2022 05:28:29)
 Match Details
 -------------
 
-To retrieve details of a specific match the method ``matchInfo()`` can be used and this is available for all``ColdWar``,
-``ModernWarfare``, ``Vanguard`` and ``Warzone`` classes. Specific match details are verbose than that of details by
-methods ``combatHistory()`` and ``combatHistoryWithDate()`` for a single match.
+To retrieve details of a specific match, the method ``matchInfo()`` can be used and this is available for all
+``ColdWar``, ``ModernWarfare``, ``Vanguard`` and ``Warzone`` classes. Details returned by this method contains
+additional data than that of details returned by the methods ``combatHistory()`` and ``combatHistoryWithDate()`` for a
+single match.
 
-The ``matchInfo()`` takes 2 input parameteres which are platform and matchId of type `cod_api.platforms`_ and integer
-respectively.
+The ``matchInfo()`` takes 2 input parameteres which are ``platform`` and ``matchId`` of type `cod_api.platforms`_ and
+integer respectively.
 
 *Optionally the match ID can be retrieved during your gameplay where it will be visible on bottom left corner*
 
 Here's an example for retrieving **Warzone** match details of a match where its id is **9484583876389482453**
-on platform **Battlenet**
+on platform **Battlenet**:
 
 .. code-block:: python
 
@@ -302,7 +307,7 @@ on platform **Battlenet**
     # loggin in with sso token
     api.login('your_sso_token')
 
-    # retrieving combat history
+    # retrieving match details
     details = api.Warzone.matchInfo(platforms.Battlenet, 9484583876389482453) # returns data of type dict
 
     # printing results to console
@@ -312,13 +317,13 @@ Season Loot
 -----------
 
 Using the ``seasonLoot()``  method a player's obtained season loot can be retrieved for a specific game and this method
-is available for ``ColdWar``, ``ModernWarfare`` and ``Vanguard`` classes
+is available for ``ColdWar``, ``ModernWarfare`` and ``Vanguard`` classes.
 
-The ``seasonLoot()`` takes 2 input parameteres which are platform and matchId of type `cod_api.platforms`_ and integer
-respectively.
+The ``seasonLoot()`` takes 2 input parameteres which are ``platform`` and ``matchId`` of type `cod_api.platforms`_ and
+integer respectively.
 
 Here's an example for retrieving **ColdWar** season loot obtained by a player whose gamer tag is **Username#1234** on
-platform **Battlenet**
+platform **Battlenet**:
 
 .. code-block:: python
 
@@ -339,10 +344,12 @@ Map List
 --------
 
 Using the ``mapList()`` method all the maps and its available modes can be retrieved for a specific game. This method is
-available for ``ColdWar``, ``ModernWarfare`` and ``Vanguard`` classes
+available for ``ColdWar``, ``ModernWarfare`` and ``Vanguard`` classes.
+
+The ``mapList()`` takes 1 input parameteres which is ``platform`` of type `cod_api.platforms`_.
 
 Here's an example for retrieving **Vanguard** map list and available modes respectively on platform PlayStation
-(**PSN**)
+(**PSN**):
 
 .. code-block:: python
 
@@ -364,8 +371,9 @@ Here's an example for retrieving **Vanguard** map list and available modes respe
 platforms
 ---------
 
-platforms is an enum class available in cod_api which is used to specify the platform in certain method calls.
-Available platforms are as follows
+``platforms`` is an enum class available in ``cod_api`` which is used to specify the platform in certain method calls.
+
+Available ``platforms`` are as follows:
 
 +----------------------+----------------------------------------+
 |Platform              | Remarks                                |
@@ -385,7 +393,7 @@ Available platforms are as follows
 |platforms.XBOX        | Xbox                                   |
 +----------------------+----------------------------------------+
 
-platforms can be imported and use as follows:
+``platforms`` can be imported and used as follows:
 
 .. code-block:: python