Clean up docstrings, to match parameter-listing to actual parameters. (#1232)

* Clean up docstrings, to match parameter-listing to actual parameters.

* Response to @meatballs' feedback.

Author: gaffney2010

axelrod/eigen.py

@@ -56,8 +56,6 @@ def principal_eigenvector(
     ------
     mat: numpy.array
         The matrix to use for multiplication iteration
-    initial: numpy.array, None
-        The initial state. Will be set to numpy.array([1, 1, ...]) if None
     maximum_iterations: int, None
         The maximum number of iterations of the approximation
     max_error: float, 1e-8

axelrod/graph.py

@@ -129,8 +129,8 @@ def complete_graph(size, loops=True):
     ----------
     size: int
         Number of vertices in the cycle
-    directed: bool, False
-        Is the graph directed?
+    loops: bool, True
+        Should the graph contain cycles?
 
     Returns
     -------

axelrod/match_generator.py

@@ -18,16 +18,16 @@ def __init__(
         ----------
         players : list
             A list of axelrod.Player objects
+        repetitions : int
+            The number of repetitions of a given match
         turns : integer
             The number of turns per match
-        prob_end : float
-            The probability of a given turn ending a match
         game : axelrod.Game
             The game object used to score the match
-        repetitions : int
-            The number of repetitions of a given match
         noise : float, 0
             The probability that a player's intended action should be flipped
+        prob_end : float
+            The probability of a given turn ending a match
         edges : list
             A list of edges between players
         match_attributes : dict

axelrod/moran.py

@@ -92,6 +92,8 @@ def __init__(
         noise:
             The background noise, if any. Randomly flips plays with probability
             `noise`.
+        game: axelrod.Game
+            The game object used to score matches.
         deterministic_cache:
             A optional prebuilt deterministic cache
         mutation_rate:

axelrod/result_set.py

@@ -56,6 +56,8 @@ def __init__(
                 efficiently read from file.
             processes : integer
                 The number of processes to be used for parallel processing
+            progress_bar: boolean
+                If a progress bar will be shown.
         """
         self.filename = filename
         self.players, self.repetitions = players, repetitions
@@ -186,8 +188,7 @@ def _reshape_three_dim_list(
         """
         Parameters
         ----------
-
-            payoffs_series : pandas.Series
+            series : pandas.Series
             first_dimension : iterable
             second_dimension : iterable
             third_dimension : iterable
@@ -223,7 +224,6 @@ def _reshape_two_dim_list(self, series):
         """
         Parameters
         ----------
-
             series : pandas.Series
 
         Returns:
@@ -446,7 +446,6 @@ def _build_eigenmoses_rating(self):
         """
         Returns:
         --------
-
         The eigenmoses rating as defined in:
         http://www.scottaaronson.com/morality.pdf
         """
@@ -459,7 +458,6 @@ def _build_eigenjesus_rating(self):
         """
         Returns:
         --------
-
         The eigenjesus rating as defined in:
         http://www.scottaaronson.com/morality.pdf
         """
@@ -474,7 +472,6 @@ def _build_cooperating_rating(self):
         """
         Returns:
         --------
-
             The list of cooperation ratings
             List of the form:
 
@@ -514,7 +511,6 @@ def _build_vengeful_cooperation(self):
         """
         Returns:
         --------
-
             The vengeful cooperation matrix derived from the
             normalised cooperation matrix:
 
@@ -608,7 +604,6 @@ def __eq__(self, other):
 
         Parameters
         ----------
-
             other : axelrod.ResultSet
                 Another results set against which to check equality
         """
@@ -642,7 +637,6 @@ def __ne__(self, other):
 
         Parameters
         ----------
-
             other : axelrod.ResultSet
                 Another results set against which to check inequality
         """
@@ -656,7 +650,6 @@ def summarise(self):
 
         Output
         ------
-
             A list of the form:
 
             [[player name, median score, cooperation_rating],...]

axelrod/strategy_transformers.py

@@ -36,10 +36,6 @@ def StrategyTransformerFactory(strategy_wrapper, name_prefix=None, reclassifier=
         A function of the form `strategy_wrapper(player, opponent, proposed_action, *args, **kwargs)`
         Can also use a class that implements
             def __call__(self, player, opponent, action)
-    wrapper_args: tuple
-        Any arguments to pass to the wrapper
-    wrapper_kwargs: dict
-        Any keyword arguments to pass to the wrapper
     name_prefix: string, "Transformed "
         A string to prepend to the strategy and class name
     reclassifier: function,

axelrod/tournament.py

@@ -115,7 +115,7 @@ def play(
         Parameters
         ----------
         build_results : bool
-            whether or not to build a results st
+            whether or not to build a results set
         filename : string
             name of output file
         processes : integer
@@ -295,7 +295,8 @@ def _run_parallel(self, processes: int = 2, build_results: bool = True) -> bool:
 
         Parameters
         ----------
-
+        build_results : bool
+            whether or not to build a results set
         processes : int
             How many processes to use.
         """
@@ -346,6 +347,8 @@ def _start_workers(
             A queue containing an entry for each round robin to be processed
         done_queue : multiprocessing.Queue
             A queue containing the output dictionaries from each round robin
+        build_results : bool
+            whether or not to build a results set
         """
         for worker in range(workers):
             process = Process(
@@ -367,6 +370,8 @@ def _process_done_queue(
             The number of sub-processes in existence
         done_queue : multiprocessing.Queue
             A queue containing the output dictionaries from each round robin
+        build_results : bool
+            whether or not to build a results set
         """
         out_file, writer = self._get_file_objects(build_results)
         progress_bar = self._get_progress_bar()
@@ -395,6 +400,8 @@ def _worker(self, work_queue: Queue, done_queue: Queue, build_results: bool = Tr
             A queue containing an entry for each round robin to be processed
         done_queue : multiprocessing.Queue
             A queue containing the output dictionaries from each round robin
+        build_results : bool
+            whether or not to build a results set
         """
         for chunk in iter(work_queue.get, "STOP"):
             interactions = self._play_matches(chunk, build_results)
@@ -410,6 +417,8 @@ def _play_matches(self, chunk, build_results=True):
         ----------
         chunk : tuple (index pair, match_parameters, repetitions)
             match_parameters are also a tuple: (turns, game, noise)
+        build_results : bool
+            whether or not to build a results set
 
         Returns
         -------