aboutsummaryrefslogtreecommitdiff
path: root/engine/evd.mli
diff options
context:
space:
mode:
authorHugo Herbelin2020-10-31 14:56:19 +0100
committerHugo Herbelin2020-11-04 16:56:49 +0100
commite7b39c73f48279980f8ea2238632bfbf6e3d4178 (patch)
tree9f7f602b9b0ab85fdffcbbb0c8643afa7a52380f /engine/evd.mli
parent4814c482eb83f4c21b6ecf2b1b9235b513221181 (diff)
Documentation of the main entry points of uState.mli.
Diffstat (limited to 'engine/evd.mli')
-rw-r--r--engine/evd.mli10
1 files changed, 8 insertions, 2 deletions
diff --git a/engine/evd.mli b/engine/evd.mli
index 40957774fe..1c5c65924c 100644
--- a/engine/evd.mli
+++ b/engine/evd.mli
@@ -155,10 +155,16 @@ val empty : evar_map
val from_env : ?binders:lident list -> env -> evar_map
(** The empty evar map with given universe context, taking its initial
- universes from env, possibly with initial universe binders. *)
+ universes from env, possibly with initial universe binders. This
+ is the main entry point at the beginning of the process of
+ interpreting a declaration (e.g. before entering the
+ interpretation of a Theorem statement). *)
val from_ctx : UState.t -> evar_map
-(** The empty evar map with given universe context *)
+(** The empty evar map with given universe context. This is the main
+ entry point when resuming from a already interpreted declaration
+ (e.g. after having interpreted a Theorem statement and preparing
+ to open a goal). *)
val is_empty : evar_map -> bool
(** Whether an evarmap is empty. *)