Miscellaneous doc fixes (#1130)

Signed-off-by: Hugo KULESZA <[email protected]>

Author: HugoKulesza

docs/user_guide/loadflow.rst

@@ -110,33 +110,33 @@ AC Load Flow
 
 In order to run an AC loadflow, simply use the :func:`run_ac` method:
 
-.. doctest::
+.. doctest:: +ELLIPSIS
 
     >>> network = pn.create_eurostag_tutorial_example1_network()
     >>> results = lf.run_ac(network, parameters=lf.Parameters(distributed_slack=False))
 
 The result is composed of a list of component results, one for each connected component of the network
 included in the computation:
 
-.. doctest::
+.. doctest:: +ELLIPSIS
 
     >>> results
-    [ComponentResult(connected_component_num=0, synchronous_component_num=0, status=CONVERGED, status_text=Converged, iteration_count=3, reference_bus_id='VLHV1_0', slack_bus_results=[SlackBusResult(id='VLHV1_0', active_power_mismatch=-606.5596837558767)], distributed_active_power=0.0)]
+    [ComponentResult(connected_component_num=0, synchronous_component_num=0, status=CONVERGED, status_text=Converged, iteration_count=3, reference_bus_id='VLHV1_0', slack_bus_results=[SlackBusResult(id='VLHV1_0', active_power_mismatch=-606.5596...)], distributed_active_power=0.0)]
 
 Component results provides general information about the loadflow execution: was it successful? How many iterations did
 it need? What is the remaining active power imbalance? For example, let's have a look at the imbalance
 on the main component of the network:
 
-.. doctest::
+.. doctest:: +ELLIPSIS
 
     >>> results[0].slack_bus_results[0].active_power_mismatch
-    -606.5596837558767
+    -606.5596...
 
 Then, the main output of the loadflow is actually the updated data in the network itself:
 all voltages and flows are now updated with the computed values. For example you can have a look at
 the voltage magnitudes (rounded to 2 digits here):
 
-.. doctest::
+.. doctest:: +ELLIPSIS
 
     >>> network.get_buses().v_mag.round(2)
     id

java/pypowsybl/src/main/java/com/powsybl/dataframe/network/extensions/LoadDetailDataframeProvider.java

@@ -40,7 +40,7 @@ public String getExtensionName() {
     @Override
     public ExtensionInformation getExtensionInformation() {
         return new ExtensionInformation(LoadDetail.NAME, "Provides active power setpoint and reactive power setpoint for a load",
-                "index : id (str), fixed_p (float), variable_p (float), fixed_q (float), variable_q (float)");
+                "index : id (str), fixed_p0 (float), variable_p0 (float), fixed_q0 (float), variable_q0 (float)");
     }
 
     private Stream<LoadDetail> itemsStream(Network network) {

pypowsybl/network/impl/network.py

@@ -127,7 +127,7 @@ def nominal_apparent_power(self, value: float) -> None:
     @property
     def per_unit(self) -> bool:
         """
-        The nominal power to per unit the network (kVA)
+        Defines if the network data should be used in per-unit.
         """
         return self._per_unit
 
@@ -1717,7 +1717,8 @@ def get_tie_lines(self, all_attributes: bool = False, attributes: Optional[List[
 
               - **dangling_line1_id**: The ID of the first dangling line
               - **dangling_line2_id**: The ID of the second dangling line
-              - **ucte_xnode_code**: The UCTE xnode code of the tie line, obtained from the dangling lines.
+              - **pairing_key**: the pairing key of the tie line, obtained from the dangling lines.
+              - **ucte_xnode_code**: deprecated for **pairing_key**.
               - **fictitious** (optional): ``True`` if the tie line is part of the model and not of the actual network
 
             This dataframe is indexed by the id of the dangling lines
@@ -4389,7 +4390,7 @@ def get_operational_limits(self, all_attributes: bool = False, attributes: Optio
         The resulting dataframe, depending on the parameters, will have some of the following columns:
 
           - **element_id**: Identifier of the network element on which this limit applies (could be for example
-            a line or a transformer). This is the index column.
+            a line or a transformer)
           - **element_type**: Type of the network element on which this limit applies (LINE, TWO_WINDINGS_TRANSFORMER,
             THREE_WINDINGS_TRANSFORMER, DANGLING_LINE)
           - **side**:       The side of the element on which this limit applies (ONE, TWO, THREE)
@@ -4402,6 +4403,8 @@ def get_operational_limits(self, all_attributes: bool = False, attributes: Optio
           - **group_name** (optional): The name of the operational limit group this limit is in
           - **selected** (optional): `True` if this limit's operational group is the selected one
 
+        The index of the dataframe is composed of the columns **element_id**, **side**, **type**, **acceptable_duration** and **group_name**.
+
         Args:
             all_attributes: flag for including all attributes in the dataframe, default is false
             attributes:     attributes to include in the dataframe. The 2 parameters are mutually

tests/test_network_extensions.py

@@ -611,7 +611,7 @@ def test_get_extensions_information():
                'attributes'] == 'index : id (str), observable (bool), p_standard_deviation (float), p_redundant (bool), q_standard_deviation (float), q_redundant (bool), v_standard_deviation (float), v_redundant (bool)'
     assert extensions_information.loc['detail']['detail'] == 'Provides active power setpoint and reactive power setpoint for a load'
     assert extensions_information.loc['detail'][
-               'attributes'] == 'index : id (str), fixed_p (float), variable_p (float), fixed_q (float), variable_q (float)'
+               'attributes'] == 'index : id (str), fixed_p0 (float), variable_p0 (float), fixed_q0 (float), variable_q0 (float)'
     assert extensions_information.loc['hvdcOperatorActivePowerRange']['detail'] == ''
     assert extensions_information.loc['hvdcOperatorActivePowerRange']['attributes'] == 'index : id (str), opr_from_cs1_to_cs2 (float), opr_from_cs2_to_cs1 (float)'
     assert extensions_information.loc['activePowerControl']['detail'] == 'Provides information about the participation of generators to balancing'