Skip to content

Commit

Permalink
Improve documentation of SourceTerm var
Browse files Browse the repository at this point in the history
  • Loading branch information
guyer committed Dec 7, 2023
1 parent 761b5f2 commit f868ca8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion fipy/terms/implicitSourceTerm.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ def __init__(self, coeff=1., var=None):
Proportionality coefficient :math:`S` (default: 1)
var : ~fipy.variables.cellVariable.CellVariable
Variable :math:`\phi` that
:class:`~fipy.terms.sourcTerm.SourceTerm` is implicit in.
:class:`~fipy.terms.implicitSourceTerm.ImplicitSourceTerm` is
implicit in.
"""
super(ImplicitSourceTerm, self).__init__(coeff=coeff, var=var)

Expand Down
2 changes: 1 addition & 1 deletion fipy/terms/sourceTerm.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def __init__(self, coeff=0., var=None):
Coefficient of source (default: 0)
var : ~fipy.variables.cellVariable.CellVariable
Variable :math:`\phi` that
:class:`~fipy.terms.sourcTerm.SourceTerm` is implicit in.
:class:`~fipy.terms.sourceTerm.SourceTerm` is implicit in.
"""
if self.__class__ is SourceTerm:
raise AbstractBaseClassError
Expand Down

0 comments on commit f868ca8

Please sign in to comment.