Ensure that transformers do not overwrite docstrings #1010
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently our docstrings get over written for a number of strategies. For example the Alexei strategy's docstring does not appear (as the class written passes through a transformer): http://axelrod.readthedocs.io/en/latest/reference/all_strategies.html#axelrod.strategies.titfortat.Alexei (Here is the source code for Alexei: http://axelrod.readthedocs.io/en/latest/_modules/axelrod/strategies/titfortat.html#Alexei This ensures the original docstring is kept and also fixes a couple of errors that then appeared in the docstrings.
drvinceknight
force-pushed
the
transformers_docstring
branch
from
280f8dc to
0a315bc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently our docstrings get overwritten for a number of strategies.
For example the Alexei strategy's docstring does not appear (as the
class written passes through a transformer):
http://axelrod.readthedocs.io/en/latest/reference/all_strategies.html#axelrod.strategies.titfortat.Alexei
(Here is the source code for Alexei:
http://axelrod.readthedocs.io/en/latest/_modules/axelrod/strategies/titfortat.html#Alexei
This ensures the original docstring is kept and also fixes a couple of
errors that then appeared in the docstrings.