Skip to content

Commit ef03f36

Browse files
fix ubuntu doctest
1 parent 2fc0611 commit ef03f36

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

pybamm/citations.py

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,25 @@ def tag_citations(self):
159159
all citations and enable verbose output with :meth:`print_citations`
160160
or :meth:`print`.
161161
162+
.. note::
163+
If a citation is registered manually, it will not be tagged.
164+
162165
Examples
163166
--------
164-
>>> pybamm.citations.register("Doyle1993")
165-
>>> pybamm.citations.print() or pybamm.print_citations()
166-
>>> Citations registered:
167-
>>> Sulzer2021 was cited due to the use of
168-
>>> pybamm.models.full_battery_models.lithium_ion.dfn
167+
.. code-block:: python
168+
:linenos:
169+
170+
pybamm.citations.register("Doyle1993")
171+
pybamm.citations.print() or pybamm.print_citations()
172+
173+
will print the following:
174+
175+
.. code-block::
176+
177+
Citations registered:
178+
Sulzer2021 was cited due to the use of
179+
pybamm.models.full_battery_models.lithium_ion.dfn
180+
169181
"""
170182
if self._citation_tags:
171183
print("Citations registered:")

0 commit comments

Comments
 (0)