Correct formatting of docstring.

Author: drvinceknight

run_strategy_indexer.py

@@ -7,7 +7,19 @@
 import os
 
 def read_index(index_path):
-    """Read the index of strategies"""
+    """
+    Read the index of strategies
+
+    Parameters
+    ----------
+    index_path : str
+        A file path for the index file where all strategies are auto documented
+
+    Returns
+    -------
+    strategies_reference : str
+        The string value of the contents of the index file.
+    """
     with open(index_path, "r") as f:
         strategies_reference = f.read()
     return strategies_reference
@@ -16,6 +28,16 @@ def get_module_name(module_path):
     """
     Take string of the form `./axelrod/strategies/titfortat.py` and returns
     `titfortat`.
+
+    Parameters
+    ----------
+    module_path : str
+        A file path for a module file.
+
+    Returns
+    -------
+    module_name : str
+        The name of the module
     """
     filename = os.path.basename(module_path)
     module_name = os.path.splitext(filename)[0]
@@ -25,11 +47,24 @@ def check_module(module_path,
                  index_path="./docs/reference/all_strategies.rst",
                  excluded=("_strategies", "__init__", "_filters", "human")):
     """
-    Check if a module is contained in the index of strategies
+    Check if a module name is written in the index of strategies.
+
+    Parameters
+    ----------
+    module_path : str
+        A file path for a module file.
+    index_path : str
+        A file path for the index file where all strategies are auto documented
+    excluded : tuple
+        A collection of module names to be ignored
+
+    Returns
+    -------
+    boolean : bool
+        True/False if module is referenced.
 
-    Returns boolean: True/False if module is referenced.
     """
-    strategies_reference = read_index(index_path)
+    strategies_index = read_index(index_path)
     module_name = get_module_name(module_path)
     if module_name not in excluded:
         if module_name not in strategies_reference: