Skip to content

Commit

Permalink
#1927 fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
rtimms committed Feb 2, 2022
1 parent 616f1cd commit aadec33
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,6 @@ class EffectiveResistance(BaseEffectiveResistance):
.. [1] R Timms, SG Marquis, V Sulzer, CP Please and SJ Chapman. “Asymptotic
Reduction of a Lithium-ion Pouch Cell Model”. SIAM Journal on Applied
Mathematics, 81(3), 765--788, 2021
.. [2] SG Marquis, R Timms, V Sulzer, CP Please and SJ Chapman. “A Suite of
Reduced-Order Models of a Single-Layer Lithium-ion Pouch Cell”. Journal
of The Electrochemical Society, 167(14):140513, 2020
**Extends:** :class:`BaseEffectiveResistance`
"""
Expand Down
2 changes: 1 addition & 1 deletion pybamm/models/submodels/thermal/base_thermal.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def _get_standard_fundamental_variables(
"""
Note: here we explicitly pass in the averages for the temperature as computing
the average temperature in `BaseThermal` using `self._x_average` requires a
messy hack to avoid raising a `ModelError` (as the key in the equation
workaround to avoid raising a `ModelError` (as the key in the equation
dict gets modified).
For more information about this method in general,
Expand Down
2 changes: 1 addition & 1 deletion pybamm/models/submodels/thermal/lumped.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

class Lumped(BaseThermal):
"""
Class for lumped thermal submodel. For more information see [1]_.
Class for lumped thermal submodel. For more information see [1]_ and [2]_.
Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pybamm/models/submodels/thermal/x_full.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class OneDimensionalX(BaseThermal):
in the current collectors, so that the contribution to the Ohmic heating
from the current collectors is zero and the boundary conditions are applied
at the edges of the electrodes (at x=0 and x=1, in non-dimensional coordinates).
For more information see [1]_.
For more information see [1]_ and [2]_.
Parameters
----------
Expand Down

0 comments on commit aadec33

Please sign in to comment.