Fix docstring

fau-advanced-separations · Mar 2, 2024 · b899751 · b899751
1 parent f84f8da
commit b899751
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/CADETProcess/dynamicEvents/event.py b/CADETProcess/dynamicEvents/event.py
@@ -72,7 +72,6 @@ class EventHandler(CachedPropertiesMixin, Structure):
     parameter_events : dict
         A dictionary mapping each parameter to the list of events that affect it.
 
-
     Notes
     -----
     The class relies heavily on the concept of "events", which are instances
@@ -157,6 +156,7 @@ def add_event(
         --------
         events
         remove_event
+        add_event_dependency
         Event
         Event.add_dependency
         add_duration

diff --git a/CADETProcess/optimization/optimizer.py b/CADETProcess/optimization/optimizer.py
@@ -69,7 +69,8 @@ class OptimizerBase(Structure):
         functions for each individual in a given population.
         The default parallelization backend is 'Joblib', which provides parallel
         execution using multiple cores.
-    n_cores
+    n_cores : int, optional
+        Proxy to the number of cores used by the parallelization backend.
     """
 
     is_population_based = False

diff --git a/CADETProcess/processModel/unitOperation.py b/CADETProcess/processModel/unitOperation.py
@@ -1037,8 +1037,8 @@ class Cstr(UnitBaseClass, SourceMixin, SinkMixin):
         Initial concentration of the bound phase.
     V : unsigned float
         Initial volume of the reactor.
-    total_porosity : UnsignedFloat between 0 and 1.
-        Total porosity of the column.
+    porosity : UnsignedFloat between 0 and 1.
+        Total porosity of the Cstr.
     flow_rate_filter: float
         Flow rate of pure liquid without components to reduce volume.
     solution_recorder : CSTRRecorder