Skip to content

Commit 04c0bbc

Browse files
committed
add missing comment
1 parent de469e4 commit 04c0bbc

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/models/supplemental_accessors.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ Calculate the admittance of AC branches
1717
get_series_susceptance(b::ACBranch) = 1 / get_x(b)
1818

1919
"""
20-
Returns the series susceptance of a controllable transformer following the convention
20+
2121
in power systems to define susceptance as the inverse of the imaginary part of the impedance.
2222
In the case of phase shifter transformers the angle is ignored.
23+
24+
See also: [`get_series_susceptances`](@ref) for 3-winding transformers
2325
"""
2426
function get_series_susceptance(b::Union{TapTransformer, PhaseShiftingTransformer})
2527
y = 1 / get_x(b)

0 commit comments

Comments
 (0)