diff options
| author | Pierre-Marie Pédrot | 2016-06-09 16:50:07 +0200 |
|---|---|---|
| committer | Pierre-Marie Pédrot | 2016-06-09 17:48:02 +0200 |
| commit | 7527751d9772656b4680df311546825cc2dd3d8f (patch) | |
| tree | 27c07324760d255939dcb9ec556bf8e309ab5186 /engine/evd.mli | |
| parent | 8efb78da7900e7f13105aac8361272477f8f5119 (diff) | |
Adding a bit of documentation in the mli.
Diffstat (limited to 'engine/evd.mli')
| -rw-r--r-- | engine/evd.mli | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/engine/evd.mli b/engine/evd.mli index 3ae6e586c1..df491c27b4 100644 --- a/engine/evd.mli +++ b/engine/evd.mli @@ -12,7 +12,10 @@ open Names open Term open Environ -(** {5 Existential variables and unification states} +(** This file defines the pervasive unification state used everywhere in Coq + tactic engine. It is very low-level and most of the functions exported here + are irrelevant to the standard API user. Consider using {!Evarutil}, + {!Sigma} or {!Proofview} instead. A unification state (of type [evar_map]) is primarily a finite mapping from existential variables to records containing the type of the evar @@ -23,6 +26,8 @@ open Environ It also contains conversion constraints, debugging information and information about meta variables. *) +(** {5 Existential variables and unification states} *) + (** {6 Evars} *) type evar = existential_key @@ -343,7 +348,6 @@ val on_sig : 'a sigma -> (evar_map -> evar_map * 'b) -> 'a sigma * 'b module MonadR : Monad.S with type +'a t = evar_map -> evar_map * 'a module Monad : Monad.S with type +'a t = evar_map -> 'a * evar_map - (** {5 Meta machinery} These functions are almost deprecated. They were used before the |