Update docstrings

Co-Authored-By: Pietro Monticone <[email protected]>
Co-Authored-By: Claudio Moroni <[email protected]>

Author: 3 people

docs/src/API.md

@@ -8,7 +8,6 @@ This page provides a list of exported methods organized by topic and audience. M
 
 ```@docs
 Node
-
 ```
 
 ### Vertices
@@ -74,6 +73,8 @@ Layer(
 ) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
 
 has_node(layer::Layer, n::Node)
+add_vertex!(layer::Layer, mv::MultilayerVertex)
+add_vertex!(layer::L, n::Node, args...; kwargs...) where {T, L <: Layer{T}} 
 rem_vertex!(layer::Layer, mv::MultilayerVertex)
 rem_vertex!(layer::Layer, n::Node)
 
@@ -198,6 +199,10 @@ mv_vertices(mg::AbstractMultilayerGraph)
 mv_inneighbors(mg::AbstractMultilayerGraph, mv::MultilayerVertex)
 mv_outneighbors(mg::AbstractMultilayerGraph, mv::MultilayerVertex)
 mv_neighbors( mg::AbstractMultilayerGraph, mv::MultilayerVertex)
+add_vertex!(mg::M, V::MultilayerVertex) where {T, U, M <: AbstractMultilayerUGraph{T,U}}
+add_vertex!(mg::M, V::MultilayerVertex) where {T, U, M <: AbstractMultilayerDiGraph{T,U}}
+rem_vertex!(mg::AbstractMultilayerUGraph, V::MultilayerVertex)
+rem_vertex!(mg::AbstractMultilayerDiGraph, V::MultilayerVertex)
 has_edge(mg::AbstractMultilayerGraph, edge::MultilayerEdge) 
 has_edge( subgraph::AbstractMultilayerGraph, s::MultilayerVertex, d::MultilayerVertex)
 ne(mg::AbstractMultilayerGraph)
@@ -218,8 +223,6 @@ is_directed(m::M) where { M <: Type{ <: AbstractMultilayerUGraph}}
 is_directed(mg::AbstractMultilayerDiGraph)
 is_directed(m::M) where { M <: Type{ <: AbstractMultilayerDiGraph}}
 has_node(mg::AbstractMultilayerGraph, n::Node)
-rem_vertex!(mg::AbstractMultilayerUGraph, V::MultilayerVertex)
-rem_vertex!(mg::AbstractMultilayerDiGraph, V::MultilayerVertex)
 set_metadata!(mg::AbstractMultilayerGraph, mv::MultilayerVertex, metadata::Union{Tuple, NamedTuple}) 
 set_metadata!(mg::AbstractMultilayerDiGraph, src::MultilayerVertex, dst::MultilayerVertex, metadata::Union{Tuple, NamedTuple})
 set_metadata!(mg::AbstractMultilayerUGraph, src::MultilayerVertex, dst::MultilayerVertex, metadata::Union{Tuple, NamedTuple})
@@ -319,11 +322,6 @@ multilayer_kronecker_delta(dims::NTuple{4,Int64})
 ```
 
 
-----------------------------------------------------
-####################################################
-----------------------------------------------------
-
-
 ## Developer
 
 ### Nodes

src/MultilayerGraphs.jl

@@ -74,6 +74,7 @@ export
     AbstractLayer,
     Layer,
     has_node,
+    add_vertex!
     rem_vertex!,
     # interlayer.jl
     AbstractInterlayer,

src/abstractmultilayergraph.jl

@@ -121,7 +121,7 @@ Graphs.has_vertex(mg::AbstractMultilayerGraph, mv::MultilayerVertex) = get_bare_
 
 Return a list of the `MultilayerVertex`s contained in `mg`.
 """
-mv_vertices(mg::AbstractMultilayerGraph)  =  [get_rich_mv(mg, v) for v in vertices(mg)]
+mv_vertices(mg::AbstractMultilayerGraph) =  [get_rich_mv(mg, v) for v in vertices(mg)]
 
 """
     nv(mg::M) where {M <: AbstractMultilayerGraph }

src/subgraphs/layer.jl

@@ -191,21 +191,22 @@ Graphs.has_vertex(layer::Layer, mv::MultilayerVertex) = MV(node(mv), name(layer)
 # TODO:
 # Implement a MultilayerVertex constructor that leaves the .layer field unspecified, for ease of use of the following function
 """
-    add_vertex!(layer::L, mv::MultilayerVertex) where { L <: Layer} 
+    add_vertex!(layer::Layer, mv::MultilayerVertex) 
 
 Add vertex to layer `layer`. 
 """
-function Graphs.add_vertex!(layer::L, mv::MultilayerVertex) where { L <: Layer}  
+function Graphs.add_vertex!(layer::Layer, mv::MultilayerVertex)
+
     (isnothing(mv.layer) || mv.layer == layer.name) || throw(ErrorException("The multilayer vertex $mv cannot belong to layer $(layer.name)."))
     add_vertex!(layer, mv.node; metadata = mv.metadata )
 end
 
 """
-    add_vertex!(layer::L, n::Node, args...; kwargs...) where {T, U, G,  L <: Layer{T,U,G}}      
+    add_vertex!(layer::L, n::Node, args...; kwargs...) where {T, L <: Layer{T}}      
 
 Add vertex associated with node `n` to layer `layer`. This method supports the uniform and transparent interfaces. See the [Vertices](@ref) section of the Tutorial.
 """
-function Graphs.add_vertex!(layer::L, n::Node, args...; kwargs...) where {T, U, G,  L <: Layer{T,U,G}} 
+function Graphs.add_vertex!(layer::L, n::Node, args...; kwargs...) where {T, L <: Layer{T}} 
     # Check if the vertex is already in the layer
     has_node(layer, n) && return false