Refactor the Ata module:

[tatoo.git] / src / tree.ml

diff --git a/src/tree.ml b/src/tree.ml
index 8f37be5..d44755e 100644 (file)
--- a/src/tree.ml
+++ b/src/tree.ml
@@ -104,9 +104,8 @@ sig
   (** Returns the kind of the given node *)
 
   val preorder : t -> node -> int
   (** Returns the kind of the given node *)
 
   val preorder : t -> node -> int

-  (** Returns the position of a node in pre-order in the tree. The
-    root has preorder 0. [nil] has pre-order [-1].
+  (** [preorder t n] returns the pre-order position of [n] in [t].
+      [preodrder t (root t) == 0] and [preorder t nil < 0].

   *)
   *)

-

   val print_node : Format.formatter -> node -> unit
 end
   val print_node : Format.formatter -> node -> unit
 end