From 0df14454fc1b9b5f3a1560e1e9b91c1ee491460c Mon Sep 17 00:00:00 2001 From: Vince Knight Date: Fri, 10 Jun 2016 13:57:54 +0100 Subject: [PATCH 1/2] Correct call for doctests. --- docs/tutorials/contributing/strategy/running_tests.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/contributing/strategy/running_tests.rst b/docs/tutorials/contributing/strategy/running_tests.rst index 936cb9e24..a33d4a97a 100644 --- a/docs/tutorials/contributing/strategy/running_tests.rst +++ b/docs/tutorials/contributing/strategy/running_tests.rst @@ -22,7 +22,7 @@ Each can be run individually:: Furthermore the documentation is also doctested, to run those tests you can run the script:: - $ sh doctest + $ python doctests.py Note that this project is being taken care off by `travis-ci `_, so all tests will be run automatically when opening From 1135cf1b9a847cdfed6a9d997469cd24cbca94e1 Mon Sep 17 00:00:00 2001 From: Vince Knight Date: Fri, 10 Jun 2016 14:47:05 +0100 Subject: [PATCH 2/2] Correcting instructions for contributions. --- .../strategy/adding_the_new_strategy.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/tutorials/contributing/strategy/adding_the_new_strategy.rst b/docs/tutorials/contributing/strategy/adding_the_new_strategy.rst index 16694eadc..5200fe474 100644 --- a/docs/tutorials/contributing/strategy/adding_the_new_strategy.rst +++ b/docs/tutorials/contributing/strategy/adding_the_new_strategy.rst @@ -7,19 +7,16 @@ in the :code:`axelrod/strategies/_strategies.py` file. If you have added your strategy to a file that already existed (perhaps you added a new variant of :code:`titfortat` to the :code:`titfortat.py` file), -add a line similar to:: +simply add your strategy to the list of strategies already imported from +`.py`:: - from import * + from import -Where :code:`file_name.py` is the name of the file you created. So for the -:code:`TitForTat` strategy which is written in the :code:`titfortat.py` file we -have:: +If you have added your strategy to a new file then simply add a line similar to +above with your new strategy. - from titfortat import * - -Once you have done that (**and you need to do this even if you have added a -strategy to an already existing file**), you need to add the class itself to -the :code:`strategies` list. +Once you have done that, you need to add the class itself to the +:code:`strategies` list (in `axelrod/strategies/_strategies.py`). Finally, if you have created a new module (a new :code:`` file) please add it to the `docs/references/all_strategies.rst` file so that it will