From ff2cdc6b666dffed8794d8c989503934c5796df1 Mon Sep 17 00:00:00 2001 From: Jonas Schulze Date: Wed, 3 Mar 2021 20:58:13 +0100 Subject: [PATCH 1/2] Fix nested list --- docs/src/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developing.md b/docs/src/developing.md index f02c76193..60a28c523 100644 --- a/docs/src/developing.md +++ b/docs/src/developing.md @@ -17,7 +17,7 @@ within the LightGraphs package should just work: - [`outneighbors`](@ref) - [`vertices`](@ref) - [`is_directed`](@ref): Note that since LightGraphs uses traits to determine directedness, `is_directed` for a `CustomGraph` type -should be implemented with **both** of the following signatures: + should be implemented with **both** of the following signatures: - `is_directed(::Type{CustomGraph})::Bool` (example: `is_directed(::Type{<:CustomGraph}) = false`) - `is_directed(g::CustomGraph)::Bool` - [`zero`](@ref) From d5cb99dda9b862b48d14ca6a5db4061419a684ea Mon Sep 17 00:00:00 2001 From: Jonas Schulze Date: Wed, 3 Mar 2021 21:07:30 +0100 Subject: [PATCH 2/2] Attach docstrings to functions This fixes all occurrences of ```bash pcregrep -Mris "\"\"\"\n\nfunc" . ``` --- src/connectivity.jl | 2 -- src/shortestpaths/spfa.jl | 1 - 2 files changed, 3 deletions(-) diff --git a/src/connectivity.jl b/src/connectivity.jl index 0c597b489..c927bed15 100644 --- a/src/connectivity.jl +++ b/src/connectivity.jl @@ -216,7 +216,6 @@ julia> strongly_connected_components(g) ``` """ - function strongly_connected_components end # see https://github.com/mauro3/SimpleTraits.jl/issues/47#issuecomment-327880153 for syntax @traitfn function strongly_connected_components(g::AG::IsDirected) where {T<:Integer, AG <: AbstractGraph{T}} @@ -374,7 +373,6 @@ julia> strongly_connected_components_kosaraju(g) ``` """ - function strongly_connected_components_kosaraju end @traitfn function strongly_connected_components_kosaraju(g::AG::IsDirected) where {T<:Integer, AG <: AbstractGraph{T}} diff --git a/src/shortestpaths/spfa.jl b/src/shortestpaths/spfa.jl index 8dec12856..f3f1859aa 100644 --- a/src/shortestpaths/spfa.jl +++ b/src/shortestpaths/spfa.jl @@ -41,7 +41,6 @@ julia> spfa_shortest_paths(gx, 1, d) ``` """ - function spfa_shortest_paths( graph::AbstractGraph{U}, source::Integer,