Skip to content

Commit 0e21d6c

Browse files
committed
docstring edits
1 parent 83af548 commit 0e21d6c

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

axelrod/fingerprint.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,9 @@ def create_jossann(point: Point, probe: Any) -> Player:
6464
Parameters
6565
----------
6666
point : Point
67-
probe : class
68-
A class that must be descended from axelrod.strategies
67+
probe : class or instance
68+
A class that must be descended from axelrod.Player or an instance of
69+
axelrod.Player.
6970
7071
Returns
7172
----------
@@ -97,8 +98,9 @@ def create_probes(probe: Union[type, Player], points: list,
9798
9899
Parameters
99100
----------
100-
probe : class
101-
A class that must be descended from axelrod.strategies.
101+
probe : class or instance
102+
A class that must be descended from axelrod.Player or an instance of
103+
axelrod.Player.
102104
points : list
103105
of Point objects with coordinates (x, y)
104106
progress_bar : bool
@@ -204,7 +206,7 @@ def reshape_data(data: dict, points: list, size: int) -> np.ndarray:
204206
return plotting_data
205207

206208

207-
class AshlockFingerprint():
209+
class AshlockFingerprint(object):
208210
def __init__(self, strategy: Union[type, Player],
209211
probe: Union[type, Player]=axl.TitForTat) -> None:
210212
"""
@@ -282,6 +284,12 @@ def fingerprint(
282284
produce more Points that will be closer together.
283285
processes : integer, optional
284286
The number of processes to be used for parallel processing
287+
filename: string, optional
288+
The name of the file for self.spatial_tournament's interactions.
289+
if None and in_memory=False, will auto-generate a filename.
290+
in_memory: bool
291+
Whether self.spatial_tournament keeps interactions_dict in memory or
292+
in a file.
285293
progress_bar : bool
286294
Whether or not to create a progress bar which will be updated
287295

0 commit comments

Comments
 (0)