[MRG+1] Documentation on docstrings requirements #872
Conversation
|
Hi @souravsingh, can you fix the warnings/errors? Run "make html" from within the docs directory to see what they are. |
| - TitForTat: [Axelrod1980]_ | ||
| """ | ||
|
|
||
| Here,the info written under thr Names section |
There was a problem hiding this comment.
typos - "Here, the info written under the Names section"
| """ | ||
|
|
||
| Here,the info written under thr Names section | ||
| tells about the source of the TitforTat strategy. |
There was a problem hiding this comment.
Could you add something to the effect of:
... TitforTat strategy. `[Axelrod1980]_` corresponds to a bibliographic item in `docs/reference/bibliography.rst`. If you are using a source that is not yet in the bibliography please add it.
| Names: | ||
| - Rapoport's strategy: [Axelrod1980]_ | ||
| - TitForTat: [Axelrod1980]_ | ||
| """ | ||
|
|
||
| Here,the info written under thr Names section |
| `docs/reference/bibliography.rst`. If you are using a source | ||
| that is not in the bibliography please add it. | ||
|
|
||
| If you are using a software code as a source of the startegy, |
There was a problem hiding this comment.
I don't think this second section is necessary. Hopefully it's clear from the first that anything can be a bibliographic item.
There was a problem hiding this comment.
I have removed it now. I added it in case if user wants to know about citing the strategy taken from a software.
|
Looks good to me, I won't put a "1 positive label" on this as all 3 of us are looking at it. :) |
|
Agreed. |
souravsingh
changed the title
|
@meatballs I believe your requested changes have been addressed? |
| - TitForTat: [Axelrod1980]_ | ||
| """ | ||
|
|
||
| Here,the info written under the Names section |
souravsingh
changed the title
Fixes #729