From e44a588f169d3ec36d96ee06a30701602bbc59b4 Mon Sep 17 00:00:00 2001 From: Jeremy Fell Date: Thu, 25 Jan 2024 21:39:56 -0800 Subject: [PATCH] Fix docstring descriptions --- src/rfbzero/degradation.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/rfbzero/degradation.py b/src/rfbzero/degradation.py index 2152168..fefcda2 100644 --- a/src/rfbzero/degradation.py +++ b/src/rfbzero/degradation.py @@ -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). """ @@ -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). """ @@ -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 @@ -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