Skip to content

Commit

Permalink
Miscellaneous documentation fixes (#893)
Browse files Browse the repository at this point in the history
Signed-off-by: Damien Jeandemange <[email protected]>
  • Loading branch information
jeandemanged authored Dec 19, 2024
1 parent c154d6b commit 9711163
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pypowsybl/network/impl/network.py
Original file line number Diff line number Diff line change
Expand Up @@ -1339,7 +1339,7 @@ def get_dangling_lines(self, all_attributes: bool = False, attributes: List[str]
- **connected**: ``True`` if the dangling line is connected to a bus
- **fictitious** (optional): ``True`` if the dangling line is part of the model and not of the actual network
- **pairing_key**: the pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte-xnode-code**: deprecated for pairing key.
- **ucte_xnode_code**: deprecated for pairing_key.
- **paired**: if the dangling line is paired with a tie line
- **tie_line_id**: the ID of the tie line if the dangling line is paired
Expand Down Expand Up @@ -4201,8 +4201,8 @@ def create_dangling_lines(self, df: DataFrame = None, generation_df: DataFrame =
- **x**: the reactance, in Ohms
- **g**: the shunt conductance, in S
- **b**: the shunt susceptance, in S
- **pairing-key**: the optional pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte-x-node-code**: deprecated, use pairing-key instead.
- **pairing_key**: the optional pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte_xnode_code**: deprecated, use pairing_key instead.
Dangling line generation information must be provided as a dataframe.
Valid attributes are:
Expand Down Expand Up @@ -4403,7 +4403,7 @@ def create_lines(self, df: DataFrame = None, **kwargs: ArrayLike) -> None:
network.create_lines(id='LINE-1', voltage_level1_id='VL1', bus1_id='B1',
voltage_level2_id='VL2', bus2_id='B2',
b1=1e-6, b2=1e-6, g1=0, , g2=0, r=0.5, x=10)
b1=1e-6, b2=1e-6, g1=0, g2=0, r=0.5, x=10)
"""
return self._create_elements(ElementType.LINE, [df], **kwargs)

Expand Down

0 comments on commit 9711163

Please sign in to comment.