Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
medha-14 committed Oct 9, 2024
1 parent 886285d commit 287cd4c
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class BasicDFN(BaseModel):
def __init__(self, name="Doyle-Fuller-Newman model"):
super().__init__(name=name)
pybamm.citations.register("Marquis2019")
# `self.param` is a class containing all the relevant parameters and functions for
# `param` is a class containing all the relevant parameters and functions for
# this model. These are purely symbolic at this stage, and will be set by the
# `ParameterValues` class when the model is processed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def __init__(self, options=None, name="Doyle-Fuller-Newman half cell model"):
options = {"working electrode": "positive"}
super().__init__(options, name)
pybamm.citations.register("Marquis2019")
# `self.param` is a class containing all the relevant parameters and functions for
# `param` is a class containing all the relevant parameters and functions for
# this model. These are purely symbolic at this stage, and will be set by the
# `ParameterValues` class when the model is processed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class BasicSPM(BaseModel):
def __init__(self, name="Single Particle Model"):
super().__init__({}, name)
pybamm.citations.register("Marquis2019")
# `self.param` is a class containing all the relevant parameters and functions for
# `param` is a class containing all the relevant parameters and functions for
# this model. These are purely symbolic at this stage, and will be set by the
# `ParameterValues` class when the model is processed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ class ElectrodeSOHSolver:
----------
parameter_values : :class:`pybamm.ParameterValues.Parameters`
The parameters of the simulation
self.param : :class:`pybamm.LithiumIonParameters`, optional
param : :class:`pybamm.LithiumIonParameters`, optional
Specific instance of the symbolic lithium-ion parameter class. If not provided,
the default set of symbolic lithium-ion parameters will be used.
known_value : str, optional
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class DiffusionLimited(BaseInterface):
Parameters
----------
self.param :
param :
model parameters
domain : str
The domain to implement the model, either: 'Negative' or 'Positive'.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class InverseButlerVolmer(BaseInterface):
Parameters
----------
self.param
param
Model parameters
domain : iter of str, optional
The domain(s) in which to compute the interfacial current.
Expand Down

0 comments on commit 287cd4c

Please sign in to comment.