aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcharguer2019-02-11 14:47:44 +0100
committerVincent Laporte2019-03-18 10:29:52 +0000
commit67847789beede10420ab631d5d0f9c2cfe9db72d (patch)
treed67a21db27592430effaf9eab56583783a298487 /doc
parent63abcb2c05ff1cab52fc6a4d3c0e93c91e8940e5 (diff)
fix documentation issues, and add entry to change log
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/practical-tools/coqide.rst21
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/sphinx/practical-tools/coqide.rst b/doc/sphinx/practical-tools/coqide.rst
index 6f48daf208..97d86943fb 100644
--- a/doc/sphinx/practical-tools/coqide.rst
+++ b/doc/sphinx/practical-tools/coqide.rst
@@ -284,15 +284,18 @@ and place it in the same folder as ``coqide.keys``. On Linux, this would be
the folder ``~/.config/coq``. The file `coqide.bindings` should contain one
binding per line, in the form ``\key value``, followed by an optional priority
integer. (The key and value should not contain any space character.)
-Here is an example configuration file:
-```
-\par ||
-\pi π 1
-\le ≤ 1
-\lambda λ 2
-\lambdas λs
-```
+.. example::
+
+ Here is an example configuration file:
+
+ ::
+
+ \par ||
+ \pi π 1
+ \le ≤ 1
+ \lambda λ 2
+ \lambdas λs
Above, the priority number 1 on ``\pi`` indicates that the prefix ``\p``
should resolve to ``\pi``, and not to something else (e.g. ``\par``).
@@ -309,7 +312,7 @@ Each of the file tokens provided may consists of one of:
- the token ``local``, which resolves to the `coqide.bindings` file
stored in the user configuration directory.
-.. remark::
+.. warning::
If a filename other than the first one includes a "~" to refer
to the home directory, it won't be expanded properly. To work around that