Skip to content

Commit

Permalink
[Doc] Argument for Falloff parameters is 'params' not 'coeffs'
Browse files Browse the repository at this point in the history
Resolves #327
  • Loading branch information
speth committed Mar 23, 2016
1 parent 60efb22 commit ac246a2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions interfaces/cython/cantera/reaction.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ cdef class Falloff:
This base class implements the simple falloff function
:math:`F(T,P_r) = 1.0`.
:param coeffs:
:param params:
Not used for the "simple" falloff parameterization.
:param init:
Used internally when wrapping :ct:`Falloff` objects returned from C++.
Expand Down Expand Up @@ -428,7 +428,7 @@ cdef class TroeFalloff(Falloff):
"""
The 3- or 4-parameter Troe falloff function.
:param coeffs:
:param params:
An array of 3 or 4 parameters: :math:`[a, T^{***}, T^*, T^{**}]` where
the final parameter is optional (with a default value of 0).
"""
Expand All @@ -439,7 +439,7 @@ cdef class SriFalloff(Falloff):
"""
The 3- or 5-parameter SRI falloff function.
:param coeffs:
:param params:
An array of 3 or 5 parameters: :math:`[a, b, c, d, e]` where the last
two parameters are optional (with default values of 1 and 0,
respectively).
Expand Down

0 comments on commit ac246a2

Please sign in to comment.