Fix docstrings for sphinx

signalling-games-org · Dec 19, 2024 · 3288b63 · 3288b63
1 parent 6368234
commit 3288b63
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 29 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -14,7 +14,7 @@ Evolve objects ``evolve.py``
     :members:
 
 Game objects ``games.py``
-----------------------------------------
+-------------------------
 
 .. automodule:: games
     :members:

diff --git a/evoke/examples/godfreysmith2013communication.py b/evoke/examples/godfreysmith2013communication.py
@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 """
-
 Evoke library examples from:
     
     Godfrey-Smith, P., & Martínez, M. (2013). Communication and Common Interest. 

diff --git a/evoke/examples/skyrms2010signals.py b/evoke/examples/skyrms2010signals.py
@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 """
-
 Evoke library examples from:
     
     Skyrms, B. (2010). Signals: Evolution, Learning, and Information. Oxford University Press.

diff --git a/evoke/src/calculate.py b/evoke/src/calculate.py
@@ -18,12 +18,13 @@ def one_basin_discrete(game, trials, times):
 
     Parameters
     ----------
-    game : One of the Evoke game classes
-        Game to be solved
+    game : One of the Evoke game classes.
+        Game to be solved.
     trials : int
-        Number of starting points to be used
-    times : evolve.Times object
+        Number of starting points to be used.
+    times : evolve.Times object.
     """
+
     pool = multiprocessing.Pool(None)
     remain = trials
     # nash = s.Nash(game)
@@ -44,12 +45,12 @@ def one_basin_discrete_aux(triple):
     ----------
     triple : tuple
         A tuple with the following elements:
-        0 : int
-            The index of the trial
-        1 : One of the Evoke game classes
-            The game to be solved
-        2 : evolve.Times object
+        int -- The index of the trial
+        One of the Evoke game classes -- The game to be solved
+        evolve.Times object
+    
     """
+
     np.random.seed()
     print("trial {}".format(triple[0]))
     game = triple[1]
@@ -91,11 +92,9 @@ def one_basin_aux_mixed(triple, print_trials=True):
     ----------
     triple : tuple
         A tuple with the following elements:
-        0 : int
-            The index of the trial
-        1 : One of the Evoke game classes
-            The game to be solved
-        2 : evolve.Times object
+        int -- The index of the trial
+        One of the Evoke game classes -- The game to be solved
+        evolve.Times object
     print_trials : bool, optional
         If True, print the trial number
     """
@@ -123,11 +122,9 @@ def one_basin_aux(triple):
     ----------
     triple : tuple
         A tuple with the following elements:
-        0 : int
-            The index of the trial
-        1 : One of the Evoke game classes
-            The game to be solved
-        2 : evolve.Times object
+        int -- The index of the trial
+        One of the Evoke game classes -- The game to be solved
+        evolve.Times object
     """
     np.random.seed()
     print("trial {}".format(triple[0]))
@@ -145,11 +142,9 @@ def one_basin_ode_aux(triple):
     ----------
     triple : tuple
         A tuple with the following elements:
-        0 : int
-            The index of the trial
-        1 : One of the Evoke game classes
-            The game to be solved
-        2 : evolve.Times object
+        int -- The index of the trial
+        One of the Evoke game classes -- The game to be solved
+        evolve.Times object
     """
     np.random.seed()
     # print("trial {}".format(triple[0]))