Skip to content

Commit

Permalink
Fix docstring descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyfell committed Jan 26, 2024
1 parent e4f3913 commit e44a588
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/rfbzero/degradation.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class ChemicalDegradationOxidized(DegradationMechanism):
rate_order : int
Rate order for chemical degradation reaction.
rate_constant : float
N-th order rate constant of chemical oxidation (unit is rate order-dependent).
N-th order rate constant of chemical degradation of oxidized species (unit is rate order-dependent).
"""

Expand Down Expand Up @@ -73,7 +73,7 @@ class ChemicalDegradationReduced(DegradationMechanism):
rate_order : int
Rate order for chemical degradation reaction.
rate_constant : float
N-th order rate constant of chemical oxidation (unit is rate order-dependent).
N-th order rate constant of chemical degradation of reduced species (unit is rate order-dependent).
"""

Expand Down Expand Up @@ -152,7 +152,7 @@ def __init__(self, rate_constant: float, c_oxidant: float = 0.0, oxidant_stoich:

def degrade(self, c_ox: float, c_red: float, time_step: float) -> tuple[float, float]:
"""
Applies a 1st order auto-oxidation mechanism to oxidized/reduced species at each time step.
Applies an auto-oxidation mechanism to oxidized/reduced species at each time step.
Defaults to first order process: red --> ox.
Parameters
Expand Down Expand Up @@ -219,7 +219,7 @@ def __init__(self, rate_constant: float, c_reductant: float = 0.0, reductant_sto

def degrade(self, c_ox: float, c_red: float, time_step: float) -> tuple[float, float]:
"""
Applies a 1st order auto-reduction mechanism to oxidized/reduced species at each time step.
Applies an auto-reduction mechanism to oxidized/reduced species at each time step.
Defaults to first order process: ox --> red.
Parameters
Expand Down

0 comments on commit e44a588

Please sign in to comment.