aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib
diff options
context:
space:
mode:
authorJean-Alexandre Barszcz <[email protected]>2017-12-02 02:53:08 -0500
committerJean-Alexandre Barszcz <[email protected]>2017-12-06 15:12:16 -0500
commitf8ccbc01e43293d610973328dfcaf5f3753c9d92 (patch)
tree10bc4fda38f933d7f2cc146695f194903e630bac /lib/stdlib
parentcba4dc777a3b870985d0a925c7b4e827468a4bb2 (diff)
downloadotp-f8ccbc01e43293d610973328dfcaf5f3753c9d92.tar.gz
otp-f8ccbc01e43293d610973328dfcaf5f3753c9d92.tar.bz2
otp-f8ccbc01e43293d610973328dfcaf5f3753c9d92.zip
digraph: Document a bad_edge error
Diffstat (limited to 'lib/stdlib')
-rw-r--r--lib/stdlib/doc/src/digraph.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/digraph.xml b/lib/stdlib/doc/src/digraph.xml
index 5332d7aba5..db96beed6c 100644
--- a/lib/stdlib/doc/src/digraph.xml
+++ b/lib/stdlib/doc/src/digraph.xml
@@ -170,6 +170,10 @@
<p>If the edge would create a cycle in
an <seealso marker="#acyclic_digraph">acyclic digraph</seealso>,
<c>{error,&nbsp;{bad_edge,&nbsp;<anno>Path</anno>}}</c> is returned.
+ If <c><anno>G</anno></c> already has an edge with value
+ <c><anno>E</anno></c> connecting a different pair of vertices,
+ <c>{error,&nbsp;{bad_edge,&nbsp;[<anno>V1</anno>,&nbsp;<anno>V2</anno>]}}</c>
+ is returned.
If either of <c><anno>V1</anno></c> or <c><anno>V2</anno></c> is not
a vertex of digraph <c><anno>G</anno></c>,
<c>{error,&nbsp;{bad_vertex,&nbsp;</c><anno>V</anno><c>}}</c> is