Skip to content

Commit 9f2901d

Browse files
InterdisciplinaryPhysicsTeampitmonticoneClaudMor
committed
Update docstrings
Co-Authored-By: Pietro Monticone <[email protected]> Co-Authored-By: Claudio Moroni <[email protected]>
1 parent f112e5a commit 9f2901d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/subgraphs/interlayer.jl

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ end
3030
# Outer constructor that performs checks. Should be the last constructor called before instantiation.
3131

3232
"""
33-
Interlayer(
33+
_Interlayer(
3434
35-
layer_1_multilayervertices::Vector{MultilayerVertex},
36-
layer_2_multilayervertices::Vector{MultilayerVertex},
35+
layer_1_multilayervertices::Vector{MultilayerVertex},
36+
layer_2_multilayervertices::Vector{MultilayerVertex},
3737
38-
edge_list::Vector{ <: MultilayerEdge{<: Union{Nothing, U}}},
39-
graph::G,
40-
v_V_associations::Bijection{T, <: MultilayerVertex},
41-
descriptor::InterlayerDescriptor{T,U,G}
42-
;
43-
check_consistency = true
44-
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
38+
edge_list::Vector{ <: MultilayerEdge{<: Union{Nothing, U}}},
39+
graph::G,
40+
v_V_associations::Bijection{T, <: MultilayerVertex},
41+
descriptor::InterlayerDescriptor{T,U,G}
42+
;
43+
check_consistency = true
44+
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
4545
4646
Internal constructor.
4747
"""
@@ -73,13 +73,13 @@ end
7373

7474
# Old inner constructor that has been removed in favor of the current inner constructor since not all graph packages implement == for the concrete graphs they define
7575
"""
76-
_Interlayer(
77-
layer_1_multilayervertices::Vector{<: MultilayerVertex},
78-
layer_2_multilayervertices::Vector{<: MultilayerVertex},
79-
edge_list::Vector{ <: MultilayerEdge}, # MultilayerVertex, {<: Union{U, Nothing}}
80-
descriptor::InterlayerDescriptor{T,U,G}
81-
82-
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
76+
_Interlayer(
77+
layer_1_multilayervertices::Vector{<: MultilayerVertex},
78+
layer_2_multilayervertices::Vector{<: MultilayerVertex},
79+
edge_list::Vector{ <: MultilayerEdge}, # MultilayerVertex, {<: Union{U, Nothing}}
80+
descriptor::InterlayerDescriptor{T,U,G}
81+
82+
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
8383
8484
Internal constructor used with InterlayerDescriptor
8585
"""

0 commit comments

Comments
 (0)