Skip to content

Commit 47cf4de

Browse files
committed
minor edits
1 parent d213929 commit 47cf4de

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ XXX ok to link a pdf? originally from `this page <https://ieeeaccess.ieee.org/gu
9090
* DOI (if available) XXX "or other link"? but don't want to encourage too many
9191
non-permanent URLs that may break at a later date though
9292

93-
For journal articles, the recommended style citation is as follows:
93+
For journal articles, the recommended citation style is as follows:
9494

9595
Author initials. Author Surname, "Title of article," abbreviated journal
9696
title, vol. number, issue number, page numbers, Abbreviated Month Year.
@@ -117,9 +117,10 @@ XXX other examples? XXX
117117
Things to note:
118118

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

0 commit comments

Comments
 (0)