Clarify undefined behavior

JuliaGraphs · Apr 6, 2023 · 8788527 · 8788527
1 parent 344b7ee
commit 8788527
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/simpleweighteddigraph.jl b/src/simpleweighteddigraph.jl
@@ -18,7 +18,7 @@ SimpleWeightedDiGraph(adjmx; permute)  # from adjacency matrix, possibly transpo
 SimpleWeightedDiGraph(sources, destinations, weights)  # from list of edges
 ```
 Use `methods(SimpleWeightedDiGraph)` for the full list of constructors.
-When building a new graph from a list of edges, you must avoid repeating `(src, dst)` pairs in the list: this can lead to undefined behavior.
+When building a new graph from a list of edges, be aware that repeating `(src, dst)` pairs may lead to undefined behavior (e.g. due to floating point errors during weight addition).
 """
 mutable struct SimpleWeightedDiGraph{T<:Integer,U<:Real} <: AbstractSimpleWeightedGraph{T,U}
     weights::SparseMatrixCSC{U,T}

diff --git a/src/simpleweightedgraph.jl b/src/simpleweightedgraph.jl
@@ -19,7 +19,7 @@ SimpleWeightedGraph(adjmx)  # from adjacency matrix
 SimpleWeightedGraph(sources, destinations, weights)  # from list of edges
 ```
 Use `methods(SimpleWeightedGraph)` for the full list of constructors.
-When building a new graph from a list of edges, you must avoid repeating `(src, dst)` pairs in the list: this can lead to undefined behavior.
+When building a new graph from a list of edges, be aware that repeating `(src, dst)` pairs may lead to undefined behavior (e.g. due to floating point errors during weight addition).
 """
 mutable struct SimpleWeightedGraph{T<:Integer,U<:Real} <: AbstractSimpleWeightedGraph{T,U}
     weights::SparseMatrixCSC{U,T}