Skip to content
Snippets Groups Projects
Commit 179bcdcb authored by Martin Constantino–Bodin's avatar Martin Constantino–Bodin
Browse files

Spellcheck.

parent bdf03404
No related branches found
No related tags found
2 merge requests!135documentation improvements,!122Minor documentation changes about tactics.
Pipeline #41923 passed
...@@ -31,7 +31,7 @@ This project targets Coq *non*-experts. Accordingly, great emphasis is placed on ...@@ -31,7 +31,7 @@ This project targets Coq *non*-experts. Accordingly, great emphasis is placed on
``` ```
- When commenting, be careful not to leave any misspelled words: Prosa's CI system comprises a spell-checker that will signal errors. - When commenting, be careful not to leave any misspelled words: Prosa's CI system comprises a spell-checker that will signal errors.
- When comments have to contain variable names or mathematical notation, use square brackets (e.g. `[job_cost j]`). You can nest square brackets _only if they are balanced_: `[[t1,t2)]` will not work. In this case, use `<<[t1,t2)>>`. - When comments have to contain variable names or mathematical notation, use square brackets (e.g. `[job_cost j]`). You can nest square brackets _only if they are balanced_: `[[t1,t2)]` will not work. In this case, use `<<[t1,t2)>>`.
- The vocabulary of the spell-checker is extended with the words contained in `scripts/wordlist.pws`. Add new words only if strictly necessary. - The vocabulary of the spell-checker is extended with the words contained in [`scripts/wordlist.pws`](../scripts/wordlist.pws). Add new words only if strictly necessary.
- Document the sources of lemmas and theorems in the comments. For example, say something like "Theorem XXX in (Foo & Bar, 2007)", and document at the beginning of the file what "(Foo & Bar, 2007)" refers to. - Document the sources of lemmas and theorems in the comments. For example, say something like "Theorem XXX in (Foo & Bar, 2007)", and document at the beginning of the file what "(Foo & Bar, 2007)" refers to.
......
...@@ -25,7 +25,7 @@ Ltac arith_goal_ssrnat2coqnat := ...@@ -25,7 +25,7 @@ Ltac arith_goal_ssrnat2coqnat :=
end. end.
(** Solve arithmetic goals. (** Solve arithmetic goals.
This tactic first rewrites the context to replace ssreflect's operations This tactic first rewrites the context to replace operations from ssreflect
to the corresponding operations in the Coq library, then calls [lia]. *) to the corresponding operations in the Coq library, then calls [lia]. *)
Ltac ssrlia := Ltac ssrlia :=
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment