diff options
| author | Hugo Herbelin | 2020-10-31 14:56:19 +0100 |
|---|---|---|
| committer | Hugo Herbelin | 2020-11-04 16:56:49 +0100 |
| commit | e7b39c73f48279980f8ea2238632bfbf6e3d4178 (patch) | |
| tree | 9f7f602b9b0ab85fdffcbbb0c8643afa7a52380f /engine/uState.mli | |
| parent | 4814c482eb83f4c21b6ecf2b1b9235b513221181 (diff) | |
Documentation of the main entry points of uState.mli.
Diffstat (limited to 'engine/uState.mli')
| -rw-r--r-- | engine/uState.mli | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/engine/uState.mli b/engine/uState.mli index d79447f6a9..bd3aac0d8b 100644 --- a/engine/uState.mli +++ b/engine/uState.mli @@ -33,11 +33,16 @@ val make : lbound:UGraph.Bound.t -> UGraph.t -> t val make_with_initial_binders : lbound:UGraph.Bound.t -> UGraph.t -> lident list -> t [@@ocaml.deprecated "Use from_env"] -val of_binders : UnivNames.universe_binders -> t - val from_env : ?binders:lident list -> Environ.env -> t +(** Main entry point at the beginning of a declaration declaring the + binding names as rigid universes. *) + +val of_binders : UnivNames.universe_binders -> t +(** Main entry point when only names matter, e.g. for printing. *) val of_context_set : Univ.ContextSet.t -> t +(** Main entry point when starting from the instance of a global + reference, e.g. when building a scheme. *) (** Misc *) |
