Skip to content

Commit

Permalink
Add count of strategies as a doctest.
Browse files Browse the repository at this point in the history
  • Loading branch information
drvinceknight committed Apr 15, 2020
1 parent 9c84f19 commit 70bffa6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ validity and reproducibility of results!
Quick start
-----------

Count the number of available players::

>>> import axelrod as axl
>>> len(axl.strategies)
236

Create matches between two players::

>>> import axelrod as axl
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ above with your new strategy.

Once you have done that, you need to add the class itself to the
:code:`all_strategies` list (in :code:`axelrod/strategies/_strategies.py`).
You will also need to increment the doctest in
:code:`axelrod/docs/index.rst`.

Finally, if you have created a new module (a new :code:`<strategy.py>` file)
please add it to the :code:`docs/references/all_strategies.rst` file so that it
Expand Down

0 comments on commit 70bffa6

Please sign in to comment.