Fix some typos in the documentatiion

oemof · Jan 11, 2021 · 81145ae · 81145ae
1 parent 815ce7c
commit 81145ae
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 21 deletions.
diff --git a/src/tespy/components/basics/cycle_closer.py b/src/tespy/components/basics/cycle_closer.py
@@ -24,11 +24,8 @@ class CycleCloser(Component):
 
     **Mandatory Equations**
 
-    .. math::
-
-        0 = p_{in} - p_{out}
-
-        0 = h_{in} - h_{out}
+    - :py:meth:`tespy.components.basics.cycle_closer.CycleCloser.pressure_equality_func`
+    - :py:meth:`tespy.components.basics.cycle_closer.CycleCloser.enthalpy_equality_func`
 
     Image not available
 

diff --git a/src/tespy/components/basics/subsystem_interface.py b/src/tespy/components/basics/subsystem_interface.py
@@ -20,21 +20,14 @@ class SubsystemInterface(Component):
     r"""
     The subsystem interface does not change fluid properties.
 
-    Equations
+    **Mandatory Equations**
 
-        **mandatory equations**
-
-        .. math:: 0 = fluid_{i,in_{j}} - fluid_{i,out_{j}} \;
-            \forall i \in \mathrm{fluid}, \; \forall j \in inlets/outlets
-
-        .. math:: 0 = \dot{m}_{in_{j}} - \dot{m}_{out_{j}} \;
-            \forall j \in inlets/outlets
-
-        .. math:: 0 = p_{in_{j}} - p_{out_{j}} \;
-            \forall j \in inlets/outlets
-
-        .. math:: 0 = h_{in_{j}} - h_{out_{j}} \;
-            \forall j \in inlets/outlets
+    - :py:meth:`tespy.components.component.Component.fluid_func`
+    - :py:meth:`tespy.components.component.Component.mass_flow_func`
+    - Pressure:
+      :py:meth:`tespy.components.basics.subsystem_interface.SubsystemInterface.variable_equality_func`
+    - Enthalpy:
+      :py:meth:`tespy.components.basics.subsystem_interface.SubsystemInterface.variable_equality_func`
 
     Inlets/Outlets
 
@@ -203,8 +196,8 @@ def variable_equality_func(self, param, doc=False):
         r"""
         Calculate the residual value for primary variable equality equation.
 
-        This equation makes mass flow, pressure or enthalpy equal at asin inlet
-        and its corresponding outlet.
+        This equation defines equatilty of mass flow, pressure or enthalpy
+        at an inlet and its corresponding outlet.
 
         Returns
         -------

diff --git a/src/tespy/components/nodes/splitter.py b/src/tespy/components/nodes/splitter.py
@@ -25,6 +25,8 @@ class Splitter(NodeBase):
 
     - :py:meth:`tespy.components.nodes.base.NodeBase.mass_flow_func`
     - :py:meth:`tespy.components.nodes.base.NodeBase.pressure_equality_func`
+    - :py:meth:`tespy.components.nodes.splitter.Splitter.fluid_func`
+    - :py:meth:`tespy.components.nodes.splitter.Splitter.energy_balance_func`
 
     Inlets/Outlets