Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General clean up of documentation #675

Closed
drvinceknight opened this issue Jul 31, 2016 · 1 comment
Closed

General clean up of documentation #675

drvinceknight opened this issue Jul 31, 2016 · 1 comment
Assignees

Comments

@drvinceknight
Copy link
Member

I think a good detailed reread of the documentation is needed. I've noticed various small little inconsistencies and there could be more. I'm not suggesting a restructure, just fixing minor errors here and there. For example here: http://axelrod.readthedocs.io/en/latest/tutorials/getting_started/tournament_results.html

There is this line:

Note: Here using string representation to deal with floating point numbers:

Which is complete nonsense (I wrote that) and a relic of what I first wrote before simplifying how the doctests worked.

So I think this just needs someone to read through the docs and pick everything up.

Another example is that we have some places where we write:

import axelrod

and others:

import axelrod as axl

Not actually a problem but could be nice to keep the same for consistency.

Whoever does this: note that it's now possible to include ... as the output of doctests. This might be helpful.

@drvinceknight
Copy link
Member Author

I'll pick this up.

@drvinceknight drvinceknight self-assigned this Aug 4, 2016
drvinceknight added a commit that referenced this issue Aug 11, 2016
Closes #675

This also lays some early work for #225 by putting a bibliography.rst
file in place and adding sources to a handful of strategies (TitForTat,
Grudger, Joss and WSLS).
- add minor modifications to landing page.
- remove incorrect statement about installation.
- tweak match docs.
- fix PEP8 in simple tournament docs.
- make minor adj to results + add bibliography
- add a bibliography and adds some references to some of the strategies.
- tidy of syntax for interactions.
- remove digits (skipping doctest anyway).
- tiny change to noisy tournament docs.
- apply minor changes to spatial tournament.
- add relevant bibliographic items.
- add reference for morality docs.
- import axl in strategy docs.
- import as axl in transformers docs.
- set a seed with axl in making tourn docs.
- make minor stylistic tweaks to read and write docs
- remove unclear part of contrib guidelines: perhaps I just misunderstood what this was saying?
- add a word to index for strategy contrib
- simplify and correct strategy contrib instructions.
- add instructions about references to contrib docs.
- improve rst syntax in add strategy docs.
- minor fixes to class contrib.
- minor tweaks to writing tests.
- grammar in running tests.
- grammar in contributing to the library.
- simplify the tournament overview section.
- sources for some strategies.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant