Skip to content

Commit 31856fd

Browse files
authored
Merge pull request #1005 from Axelrod-Python/docstring-space
Add a blank line in docstring documentation.
2 parents ff0fdb9 + 80245ec commit 31856fd

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/tutorials/contributing/strategy/docstrings.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ Writing docstrings
22
==================
33

44
The project takes pride in its documentation for the strategies
5-
and its corresponding bibliography. The docstring is a string
6-
which describes a method, module or class. The docstrings help
7-
the user in understanding the working of the strategy
5+
and its corresponding bibliography. The docstring is a string
6+
which describes a method, module or class. The docstrings help
7+
the user in understanding the working of the strategy
88
and the source of the strategy. The docstring must be written in
99
the following way, i.e.::
1010

@@ -13,7 +13,7 @@ the following way, i.e.::
1313
It can be written over multiple lines.
1414

1515
"""
16-
16+
1717
Sections
1818
--------
1919

@@ -25,7 +25,7 @@ The Sections of the docstring are:
2525

2626
class TitForTat(Player):
2727
"""
28-
A player starts by cooperating and then mimics the
28+
A player starts by cooperating and then mimics the
2929
previous action of the opponent.
3030
"""
3131

@@ -35,19 +35,20 @@ The Sections of the docstring are:
3535
or the paper from which the strategy was taken.
3636
The section must start with the Names section.
3737
For E.g.::
38-
38+
3939
class TitForTat(Player):
4040
"""
41-
A player starts by cooperating and then mimics the
41+
A player starts by cooperating and then mimics the
4242
previous action of the opponent.
43-
43+
4444
Names:
45+
4546
- Rapoport's strategy: [Axelrod1980]_
4647
- TitForTat: [Axelrod1980]_
4748
"""
48-
49+
4950
Here, the info written under the Names section
5051
tells about the source of the TitforTat strategy.
51-
`[Axelrod1980]_` corresponds to the bibliographic item in
52-
`docs/reference/bibliography.rst`. If you are using a source
53-
that is not in the bibliography please add it.
52+
`[Axelrod1980]_` corresponds to the bibliographic item in
53+
`docs/reference/bibliography.rst`. If you are using a source
54+
that is not in the bibliography please add it.

0 commit comments

Comments
 (0)