Merge pull request #17 from JuliaGraphs/sbromberger/fix-13

Sbromberger/fix 13
JuliaGraphs · Aug 19, 2018 · f10be3e · f10be3e
2 parents d90eedb + ca2250c
commit f10be3e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/src/StaticGraphs.jl b/src/StaticGraphs.jl
@@ -44,11 +44,11 @@ const AbstractStaticEdge{T} = AbstractSimpleEdge{T}
 const StaticEdge{T} = SimpleEdge{T}
 
 """
-    AbstractStaticGraph
+    AbstractStaticGraph{T, U}
 
-An abstract type representing a simple graph structure.
-AbstractStaticGraphs must have the following elements:
-- weightmx::AbstractSparseMatrix{Real}
+An abstract type representing a simple graph structure parameterized by integer types
+- `T`: the type representing the graph's vertices
+- `U`: the type representing the number of edges in the graph
 """
 abstract type AbstractStaticGraph{T<:Integer, U<:Integer} <: AbstractSimpleGraph{T} end
 

diff --git a/src/staticdigraph.jl b/src/staticdigraph.jl
@@ -1,5 +1,5 @@
 """
-    StaticDiGraph{T, U}
+    StaticDiGraph{T, U} <: AbstractStaticGraph{T, U}
 
 A type representing a static directed graph.
 """

diff --git a/src/staticgraph.jl b/src/staticgraph.jl
@@ -1,7 +1,7 @@
 
 
 """
-    StaticGraph{T, U}
+    StaticGraph{T, U} <: AbstractStaticGraph{T, U}
 
 A type representing an undirected static graph.
 """