Add a docstring to strategies that do not obey axl

This indicates that time should not be spent optimising them. See #941
Axelrod-Python · Mar 29, 2017 · 483a256 · 483a256
1 parent 9878d0c
commit 483a256
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/axelrod/strategies/darwin.py b/axelrod/strategies/darwin.py
@@ -1,3 +1,8 @@
+"""
+The player class in this module does not obey standard rules of the IPD (as
+indicated by their classifier). We do not recommend putting a lot of time in to
+optimising it.
+"""
 import inspect
 from axelrod.actions import Action, Actions
 from axelrod.player import Player

diff --git a/axelrod/strategies/geller.py b/axelrod/strategies/geller.py
@@ -1,3 +1,8 @@
+"""
+The player classes in this module do not obey standard rules of the IPD (as
+indicated by their classifier). We do not recommend putting a lot of time in to
+optimising them.
+"""
 import inspect
 
 from axelrod.actions import Actions, Action

diff --git a/axelrod/strategies/mindreader.py b/axelrod/strategies/mindreader.py
@@ -1,3 +1,8 @@
+"""
+The player classes in this module do not obey standard rules of the IPD (as
+indicated by their classifier). We do not recommend putting a lot of time in to
+optimising them.
+"""
 import inspect
 
 from axelrod.actions import Actions, Action