diff options
| author | Hugo Herbelin | 2016-08-26 15:15:44 +0200 |
|---|---|---|
| committer | Hugo Herbelin | 2016-09-09 09:29:47 +0200 |
| commit | 6eefbf216bd4d674f84a7827ecb205c6e12c33d3 (patch) | |
| tree | 1656f8cbd1f0f93c4076d9151a8564e2e4f728ce /dev/doc/api.txt | |
| parent | 5ecd8a6a5593d7f197a115b129ebd5f530e40161 (diff) | |
A proposal for recommended uniformity of style in programming Coq.
Starting listing some recommendations in using the API.
Diffstat (limited to 'dev/doc/api.txt')
| -rw-r--r-- | dev/doc/api.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/dev/doc/api.txt b/dev/doc/api.txt new file mode 100644 index 0000000000..5827257b53 --- /dev/null +++ b/dev/doc/api.txt @@ -0,0 +1,10 @@ +Recommendations in using the API: + +The type of terms: constr (see kernel/constr.ml and kernel/term.ml) + +- On type constr, the canonical equality on CIC (up to + alpha-conversion and cast removal) is Constr.equal +- The type constr is abstract, use mkRel, mkSort, etc. to build + elements in constr; use "kind_of_term" to analyze the head of a + constr; use destRel, destSort, etc. when the head constructor is + known |