From 1199cbc1a45e378e41f4b159c4c62db598173716 Mon Sep 17 00:00:00 2001
From: Gaëtan Gilbert
Date: Tue, 18 Dec 2018 10:53:31 +0100
Subject: Add comment to acyclicgraph API

---
 lib/acyclicGraph.mli | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/acyclicGraph.mli b/lib/acyclicGraph.mli
index 13a12b51cd..b53a4c018f 100644
--- a/lib/acyclicGraph.mli
+++ b/lib/acyclicGraph.mli
@@ -39,10 +39,13 @@ module Make (Point:Point) : sig
 
   exception AlreadyDeclared
   val add : ?rank:int -> Point.t -> t -> t
-  (** Use a large [rank] to keep the node canonical *)
+  (** All points must be pre-declared through this function before
+     they can be mentioned in the others. NB: use a large [rank] to
+     keep the node canonical *)
 
   exception Undeclared of Point.t
   val check_declared : t -> Point.Set.t -> unit
+  (** @raise Undeclared if one of the points is not present in the graph. *)
 
   type 'a check_function = t -> 'a -> 'a -> bool
 
-- 
cgit v1.2.3