Add to docstring

openego · Sep 13, 2024 · aba78ef · aba78ef
1 parent 44708e1
commit aba78ef
Showing 1 changed file with 11 additions and 7 deletions.
diff --git a/edisgo/network/topology.py b/edisgo/network/topology.py
@@ -2369,6 +2369,8 @@ def connect_to_lv_based_on_geolocation(
         `max_distance_from_target_bus`. Otherwise, the new component is directly
         connected to the nearest bus.
 
+        In the following are some more details on the methodology:
+
         * Method:
             * Voltage level 6:
                 If the voltage level is 6, the component is connected to the closest
@@ -2380,11 +2382,12 @@ def connect_to_lv_based_on_geolocation(
 
             * Voltage level 7:
                 If the voltage level is 7, the component is connected to the closest
-                LV bus.
+                LV bus. Two main cases can be distinguished:
 
                 * No MV connection allowed:
                     If the distance to the closest LV bus is less than the specified
-                    maximum distance, the component is connected to the closest LV bus.
+                    maximum distance `max_distance_from_target_bus`, the component is
+                    connected to the closest LV bus.
                     If the distance is greater, a new bus is created for the component.
                     If there are already components of the same type connected to the
                     target bus, the component is connected to the closest LV bus with
@@ -2396,13 +2399,14 @@ def connect_to_lv_based_on_geolocation(
 
                 * MV connection allowed:
                     If the distance to the closest LV bus is less than the specified
-                    maximum distance, the component is connected to the closest LV bus.
+                    maximum distance `max_distance_from_target_bus`, the component is
+                    connected to the closest LV bus.
                     If the distance is greater, the distance to the closest MV bus is
                     calculated. If the distance to the closest MV bus multiplied with
-                    the factor is less than the distance to the closest LV bus, the
-                    component is connected to the closest MV bus. The is no restriction
-                    on the number of components of the same type connected to
-                    the MV bus. If the distance is greater, the component
+                    the factor `factor_mv_connection` is less than the distance to the
+                    closest LV bus, the component is connected to the closest MV bus.
+                    There is no restriction on the number of components of the same type
+                    connected to the MV bus. If the distance is greater, the component
                     is connected to a new LV bus.
 
         Parameters