added some comments, but the samentics of many functions is still unclear to me

diff --git a/helm/software/components/tactics/universe.ml b/helm/software/components/tactics/universe.ml
index 6a0a3156664b6106b965260ac6227a07a1c1fa27..c4e439efe34ca8ffa579b4e94a95e7ebd0066a70 100644 (file)
--- a/helm/software/components/tactics/universe.ml
+++ b/helm/software/components/tactics/universe.ml
@@ -120,7 +120,7 @@ let keys context ty =
     [head true ty; head true (unfold context ty)]
   with ProofEngineTypes.Fail _ -> [head true ty]
 
-let key term = head false term
+let key term = head false term;;
 
 let index_term_and_unfolded_term univ context t ty =
   let key = head true ty in

diff --git a/helm/software/components/tactics/universe.mli b/helm/software/components/tactics/universe.mli
index 9201d92b82ae5140b08ba701420b640525ca7716..de7c2087174b4be352a1b4dc838521c167a70af4 100644 (file)
--- a/helm/software/components/tactics/universe.mli
+++ b/helm/software/components/tactics/universe.mli
@@ -24,19 +24,31 @@
  *)
 
 type universe
+
 val empty : universe
+
+(* retrieves the list of term that hopefully unify *)
 val get_candidates: universe -> Cic.term -> Cic.term list
-val index:
-  universe -> 
-  Cic.term -> (* key *)
-  Cic.term -> (* value *)
-  universe
+
+(* index [univ] [key] [term] *)
+val index: universe -> Cic.term -> Cic.term -> universe
+
+(* collapse non-indexable terms, removing coercions an unfolding the head
+ * constant if any *)
 val keys: Cic.context -> Cic.term -> Cic.term list
-val key: Cic.term -> Cic.term
+
+(* collapse non-indexable terms, not removing coercions *)
+val key: Cic.term -> Cic.term 
+
+(* indexes the term and its unfolded both without coercions *)
 val index_term_and_unfolded_term: 
   universe -> Cic.context -> Cic.term -> Cic.term -> universe
+
+(* indexex the term without coercions, with coercions and unfolded without
+ * coercions *)
 val index_local_term: 
   universe -> Cic.context -> Cic.term -> Cic.term -> universe
+
 (* pairs are (term,ty) *)
 val index_list: 
     universe -> Cic.context -> (Cic.term*Cic.term) list -> universe