Skip to content

Commit f112e5a

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

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

docs/src/API.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ rem_vertex!(layer::Layer, mv::MultilayerVertex)
8282
rem_vertex!(layer::Layer, n::Node)
8383
8484
Interlayer{T<:Integer,U<:Real,G<:AbstractGraph{T}}
85-
8685
Interlayer(
8786
layer_1::Layer{T,U},
8887
layer_2::Layer{T,U},
@@ -91,7 +90,7 @@ Interlayer(
9190
default_edge_weight::Function = (x,y) -> nothing,
9291
default_edge_metadata::Function = (x,y) -> NamedTuple(),
9392
transfer_vertex_metadata::Bool = false,
94-
name::Symbol
93+
name::Symbol = Symbol("interlayer_$(layer_1.name)_$(layer_2.name)")
9594
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
9695
9796

src/subgraphs/interlayer.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Constructor for Interlayer.
116116
117117
- `layer_1::Layer{T,U}`: one of the two layers connected by the Interlayer;
118118
- `layer_2::Layer{T,U}`: one of the two layers connected by the Interlayer;
119-
- `ne::Int64`: The number of edges of the Interlayer;
119+
- `edge_list::Vector{ <: MultilayerEdge{<: Union{U, Nothing}}}`: The `MultilayerEdge` list of the Interlayer;
120120
- `null_graph::G`: the Interlayer's underlying graph type, which must be passed as a null graph. If it is not, an error will be thrown.
121121
122122
# KWARGS

0 commit comments

Comments
 (0)