aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/proof-engine
diff options
context:
space:
mode:
authorThéo Zimmermann2018-04-24 11:59:49 +0200
committerThéo Zimmermann2018-05-05 11:54:03 +0200
commitbea89948b3b9d508726b52a4e2fed3fa843717ef (patch)
tree2514e067b489276d8f642c6cdff3f8afc2f71cf0 /doc/sphinx/proof-engine
parent963f07af424df45e09064bc8c8600c34e369f772 (diff)
Clean-up around options.
- Remove all trailing dots. - There is only one Bullet Behavior option. - Replaces `@natural` and `@integer` by `@num`.
Diffstat (limited to 'doc/sphinx/proof-engine')
-rw-r--r--doc/sphinx/proof-engine/ltac.rst2
-rw-r--r--doc/sphinx/proof-engine/proof-handling.rst19
-rw-r--r--doc/sphinx/proof-engine/tactics.rst2
-rw-r--r--doc/sphinx/proof-engine/vernacular-commands.rst4
4 files changed, 11 insertions, 16 deletions
diff --git a/doc/sphinx/proof-engine/ltac.rst b/doc/sphinx/proof-engine/ltac.rst
index b70c79f689..2d08acc402 100644
--- a/doc/sphinx/proof-engine/ltac.rst
+++ b/doc/sphinx/proof-engine/ltac.rst
@@ -1147,7 +1147,7 @@ Info trace
script. In particular, the calls to idtac in branches which failed are
not printed.
- .. opt:: Info Level @num.
+ .. opt:: Info Level @num
This option is an alternative to the ``Info`` command.
diff --git a/doc/sphinx/proof-engine/proof-handling.rst b/doc/sphinx/proof-engine/proof-handling.rst
index 64e28cea43..53205b6193 100644
--- a/doc/sphinx/proof-engine/proof-handling.rst
+++ b/doc/sphinx/proof-engine/proof-handling.rst
@@ -95,7 +95,7 @@ has been opened using the ``Goal`` command.
.. cmd:: Admitted.
:name: Admitted (interactive proof)
-This command is available in interactive editing proof mode to give up
+This command is available in interactive editing mode to give up
the current proof and declare the initial goal as an axiom.
.. cmd:: Proof @term.
@@ -185,14 +185,14 @@ Proof using options
The following options modify the behavior of ``Proof using``.
-.. opt:: Default Proof Using "@expression".
+.. opt:: Default Proof Using "@expression"
Use :n:`@expression` as the default ``Proof``` using value. E.g. ``Set Default
Proof Using "a b"``. will complete all ``Proof`` commands not followed by a
using part with using ``a`` ``b``.
-.. opt:: Suggest Proof Using.
+.. opt:: Suggest Proof Using
When ``Qed`` is performed, suggest a using annotation if the user did not
provide one.
@@ -427,17 +427,12 @@ You just finished a goal focused by ``{``, you must unfocus it with ``}``.
Set Bullet Behavior
```````````````````
+.. opt:: Bullet Behavior %( "None" %| "Strict Subproofs" %)
-The bullet behavior can be controlled by the following commands.
-
-.. opt:: Bullet Behavior "None"
-
-This makes bullets inactive.
-
-.. opt:: Bullet Behavior "Strict Subproofs"
-
-This makes bullets active (this is the default behavior).
+ This option controls the bullet behavior and can take two possible values:
+ - "None": this makes bullets inactive.
+ - "Strict Subproofs": this makes bullets active (this is the default behavior).
.. _requestinginformation:
diff --git a/doc/sphinx/proof-engine/tactics.rst b/doc/sphinx/proof-engine/tactics.rst
index 5673b496e6..526a7d3bf3 100644
--- a/doc/sphinx/proof-engine/tactics.rst
+++ b/doc/sphinx/proof-engine/tactics.rst
@@ -3860,7 +3860,7 @@ inductive definition.
This combines the effects of the different variants of :tacn:`firstorder`.
-.. opt:: Firstorder Depth @natural
+.. opt:: Firstorder Depth @num
This option controls the proof-search depth bound.
diff --git a/doc/sphinx/proof-engine/vernacular-commands.rst b/doc/sphinx/proof-engine/vernacular-commands.rst
index 692ff294a6..672c7a0fe1 100644
--- a/doc/sphinx/proof-engine/vernacular-commands.rst
+++ b/doc/sphinx/proof-engine/vernacular-commands.rst
@@ -1131,13 +1131,13 @@ Controlling display
:cmd:`SearchPattern`, :cmd:`SearchRewrite` etc. to omit types from their
output, printing only identifiers.
-.. opt:: Printing Width @integer
+.. opt:: Printing Width @num
This command sets which left-aligned part of the width of the screen is used
for display. At the time of writing this documentation, the default value
is 78.
-.. opt:: Printing Depth @integer
+.. opt:: Printing Depth @num
This option controls the nesting depth of the formatter used for pretty-
printing. Beyond this depth, display of subterms is replaced by dots. At the