Skip to content

Commit d213929

Browse files
committed
`` edit
1 parent 4b9e602 commit d213929

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,14 @@ using the IEEE style in a docstring::
112112
(PVSC), Austin, TX, USA, 2012, pp. 3048-3052,
113113
:doi:`10.1109/PVSC.2012.6318225`.
114114

115+
XXX other examples? XXX
116+
115117
Things to note:
116118

117119
* In text numeric citations require a number inside square brackets, followed
118-
by an underscore, e.g. `[1]_`
120+
by an underscore, e.g. ``[1]_``
119121
* To include a DOI, you can use the existing `Sphinx role <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`_,
120-
with the DOI string, e.g. `:doi:10.21105/joss.05994`.
122+
with the DOI string, e.g. `` :doi:`10.21105/joss.05994` ``.
121123
* The citation formatting must be consistent within the same docstring, for
122124
example if you abbreviate the author list after one author in the first
123125
citation then you should do so in all citations.

0 commit comments

Comments
 (0)