Final review of PR326

Author: MassimoCimmino

CHANGELOG.md

@@ -5,7 +5,7 @@
 ### New features
 
 * [Pull Request 325](https://github.com/MassimoCimmino/pygfunction/pull/325) - Borefields and boreholes can now be concatenated using the `+` operator, e.g. using `new_field = field_1 + field_2`.
-* [Pull Request 326](https://github.com/MassimoCimmino/pygfunction/pull/326) - Introduced `gFunction.from_static_params` and `Network.from_static_params` methods. These methods facilitate the creation of `Network` objects and the evaluation g-functions by automatically evaluating the required thermal resistances for the creation of `Pipe` objects.
+* [Pull Request 326](https://github.com/MassimoCimmino/pygfunction/pull/326) - Introduced `gFunction.from_static_params` and `Network.from_static_params` methods. These methods facilitate the creation of `Network` objects and the evaluation of g-functions by automatically evaluating the required thermal resistances for the creation of `Pipe` objects.
 
 ### Other changes
 

pygfunction/gfunction.py

@@ -341,7 +341,7 @@ def from_static_params(cls,
             Method for the evaluation of the g-function. Should be one of 'similarities', 'detailed', or 'equivalent'.
             Default is 'equivalent'. See 'gFunction' __init__ for more details.
         m_flow_network : float, optional
-            Fluid mass flow rate into the network of boreholes.
+            Fluid mass flow rate into the network of boreholes (in kg/s).
             Default is None.
         options : dict, optional
             A dictionary of solver options. See 'gFunction' __init__ for more details.

pygfunction/networks.py

@@ -144,7 +144,7 @@ def from_static_params(cls,
         k_p : float, tuple, or (2,) array
             Pipe thermal conductivity (in W/m-K).
         m_flow_network : float
-            Fluid mass flow rate into the network of boreholes.
+            Fluid mass flow rate into the network of boreholes (in kg/s).
         epsilon : float
             Pipe roughness (in meters).
        fluid_str: str
@@ -164,7 +164,8 @@ def from_static_params(cls,
             True to treat a negative mass flow rate as the reversal of flow
             direction within the borehole. If False, the direction of flow is not
             reversed when the mass flow rate is negative, and the absolute value is
-            used for calculations. Equals to True.
+            used for calculations.
+            Default is True.
         bore_connectivity : list, optional
             Index of fluid inlet into each borehole. -1 corresponds to a borehole
             connected to the bore field inlet. If this parameter is not provided,
@@ -174,6 +175,7 @@ def from_static_params(cls,
             Number of multipoles per pipe to evaluate the thermal resistances.
             J=1 or J=2 usually gives sufficient accuracy. J=0 corresponds to the
             line source approximation.
+            Default is 2.
 
         Returns
         -------

pygfunction/pipes.py

@@ -3632,7 +3632,7 @@ def fluid_to_pipe_thermal_resistance(
         Should be one of 'PipeType.COAXIAL_ANNULAR_IN', 'PipeType.COAXIAL_ANNULAR_OUT',
         'PipeType.DOUBLE_UTUBE_PARALLEL', 'PipeType.DOUBLE_UTUBE_SERIES', or 'PipeType.SINGLE_UTUBE'.
     m_flow_borehole : float
-        Fluid mass flow rate the borehole.
+        Fluid mass flow rate the borehole (in kg/s).
     r_in : float
         Inner radius (in meters) of the U-Tube pipes.
     r_out : float
@@ -3642,11 +3642,12 @@ def fluid_to_pipe_thermal_resistance(
     epsilon : float
         Pipe roughness (in meters).
     fluid : Fluid
-        'Fluid' class object. used for evaluating fluid properties
+        'Fluid' class object. Used for evaluating fluid properties
 
     Returns
     -------
-    fluid to pipe thermal resistance (in m-K/W)
+    float
+        fluid to pipe thermal resistance (in m-K/W)
 
     """
 
@@ -3754,7 +3755,7 @@ def fluid_to_fluid_thermal_resistance(pipe_type: PipeType, m_flow_borehole: floa
         Should be one of 'PipeType.COAXIAL_ANNULAR_IN', 'PipeType.COAXIAL_ANNULAR_OUT',
         'PipeType.DOUBLE_UTUBE_PARALLEL', 'PipeType.DOUBLE_UTUBE_SERIES', or 'PipeType.SINGLE_UTUBE'.
     m_flow_borehole : float
-        Fluid mass flow rate the borehole.
+        Fluid mass flow rate the borehole (in kg/s).
     r_in : float
         Inner radius (in meters) of the U-Tube pipes.
     r_out : float
@@ -3764,11 +3765,12 @@ def fluid_to_fluid_thermal_resistance(pipe_type: PipeType, m_flow_borehole: floa
     epsilon : float
         Pipe roughness (in meters).
     fluid : Fluid
-        'Fluid' class object. used for evaluating fluid properties
+        'Fluid' class object. Used for evaluating fluid properties
 
     Returns
     -------
-    fluid to fluid thermal resistance (in m-K/W)
+    float
+        fluid to fluid thermal resistance (in m-K/W)
 
     """