docs corrections

docs/src/reference.md

@@ -13,6 +13,10 @@ Creating a hypergraph
 
 ```@docs
 Hypergraph
+random_model(::Int, ::Int)
+random_kuniform_model(::Int, ::Int, ::Int)
+random_dregular_model(::Int, ::Int, ::Int)
+random_preferential_model
 ```
 
 Manipulating vertices and hyperedges
@@ -26,6 +30,7 @@ get_vertex_meta(::Hypergraph{T, V, E}, ::Int) where {T <: Real, V, E}
 set_hyperedge_meta!(::Hypergraph{T, V, E}, ::Union{E,Nothing}, ::Int) where {T <: Real, V, E}
 get_hyperedge_meta(::Hypergraph{T, V, E}, ::Int) where {T <: Real, V, E}
 remove_vertex!(::Hypergraph, ::Int)
+remove_hyperedge!(::Hypergraph, ::Int)
 ```
 
 Hypergraph array getters and setters
@@ -77,11 +82,11 @@ gethyperedges(::Hypergraph, ::Int)
 get_connected_components(::Hypergraph)
 
 conductance(::Hypergraph, ::Set{Int})
-modularity(::Hypergraph, ::Vector{Set{Int}}, ::SimpleHypergraphs.HypergraphAggs)
-random_walk(::Hypergraph, ::Int; heselect::Function, vselect::Function)
-
+get_twosection_adjacency_mx
 random_walk(::Hypergraph, ::Int; ::Function, ::Function)
 
+modularity(::Hypergraph, ::Vector{Set{Int}}, ::SimpleHypergraphs.HypergraphAggs)
+
 SimpleHypergraphs.HypergraphAggs
 
 randompartition(::Int64,::Int64)

src/conductance.jl

@@ -8,7 +8,6 @@ For more information see `1. Introduction` at:
 Generalizing the Hypergraph Laplacian via a Diffusion Processwith Mediators,
 auhtors: T-H. Hubert Chan, Xhibin Liang.
 """
-
 function conductance(h::Hypergraph, subset::Set{Int})::Float64
   if isempty(subset) error("`subset` is not allowed empty.") end
   if subset == Set(1:nhv(h)) error("`subset` is not allowed true subset of `h`.") end

src/hypergraph.jl

@@ -151,13 +151,6 @@ If a vertex does not belong to a hyperedge `nothing` is returned.
     get(h.v2he[idx[1]], idx[2], nothing)
 end
 
-@inline function Base.pop!(d::SortedDict,key::Int,::Nothing)
-    if haskey(d,key)
-        return pop!(d,key)
-    else
-        return nothing
-    end
-end
 
 """
     Base.setindex!(h::Hypergraph, ::Nothing, idx::Vararg{Int,2})

src/models.jl

@@ -8,7 +8,7 @@
 
 
 """
-    random_model(nVertices, nEdges)
+    random_model(nVertices::Int, nEdges::Int)
 
 Generate a *random* hypergraph without any structural constraints.
 
@@ -39,7 +39,7 @@ end
 
 
 """
-    random_kuniform_model(nVertices, nEdges, k)
+    random_kuniform_model(nVertices::Int, nEdges::Int, k::Int)
 
 Generates a *k*-uniform hypergraph, i.e. an hypergraph where each hyperedge has size *k*.
 
@@ -57,7 +57,7 @@ end
 
 
 """
-    random_dregular_model(nVertices, nEdges, d)
+    random_dregular_model(nVertices::Int, nEdges::Int, d::Int)
 
 Generates a *d*-regular hypergraph, where each node has degree *d*.
 

src/twosection.jl

@@ -155,7 +155,7 @@ LightGraphs.zero(::Type{TwoSectionView{T}}) where T = TwoSectionView(Hypergraph{
     get_twosection_adjacency_mx(h::Hypergraph{T,V,E}; count_self_loops::Bool=false,
                                 replace_weights::Union{Nothing,Real}=nothing ) where {T<:Real, V, E}
 
-    Returns an adjacency matrix for a two section view of a hypergraph `h`.
+Returns an adjacency matrix for a two section view of a hypergraph `h`.
 """
 function get_twosection_adjacency_mx(h::Hypergraph{T,V,E}; count_self_loops::Bool=false,
                                      replace_weights::Union{Nothing,Real}=nothing ) where {T<:Real, V, E}