on master help sign in
Update tactics documentation based on deprecation
commit8a1bc7dc81459656c3af0a8bd1a216d24456f4e5 authorDavid Raymond Christiansen <david@davidchristiansen.dk> dateWed 23 Sep 2015, 13:36 (11 years ago) parentce403f6
2 files changed+19−13
docs/reference/elaborator-reflection.rst+9−7 docs/reference/tactics.rst+10−6
docs/reference/elaborator-reflection.rst+9−7
@@ -11,11 +11,6 @@ For details, see Edwin Brady's 2013 paper in the Journal of Functional Programmi
1111Elaborator reflection makes the elaboration type as well as a selection of its tactics available to Idris code.
1212This means that metaprograms written in Idris can have complete control over the elaboration process, generating arbitrary code, and they have access to all of the facilities available in the elaborator, such as higher-order unification, type checking, and emitting auxiliary definitions.
1313
14−WARNING
15−=======
16−
17−Elaborator reflection is a new, **experimental** feature. It **will change**. You've been warned.
18−
1914The Elaborator State
2015====================
2116
@@ -81,8 +76,15 @@ Interactively Building Elab Scripts
8176
8277To build an ``Elab`` script interactively, use the ``:elab`` command at the REPL.
8378It takes the name of a hole as an argument.
84−The interface is largely the same as in Idris's interactive prover, except all meta-commands start with colon.
85−For example, use ``:qed`` instead of ``qed``, ``:abandon`` instead of ``abandon``, and ``:undo`` instead of ``undo``.
79+To list all available holes, use the command ``:m``.
80+
81+In interactive elaboration shell, the following commands are available:
82+- ``:q`` - Quits the elaboration shell (gives up on proving current lemma).
83+- ``:abandon`` - Same as :q
84+- ``:state`` - Displays the current state of the term being constructed.
85+- ``:term`` - Displays the current proof term complete with its yet-to-be-filled holes.
86+- ``:undo`` - Undoes the last tactic.
87+- ``:qed`` - Once the elaboration shell tells you "No more goals," you get to type this in celebration! (Completes the construction and exits the shell)
8688
8789
8890Failure
docs/reference/tactics.rst+10−6
@@ -1,7 +1,11 @@
11***************************
2−Tactics and Theorem Proving
2+DEPRECATED: Tactics and Theorem Proving
33***************************
44
5+.. warning::
6+ The interactive theorem-proving interface documented here has been
7+ deprecated in favor of :ref:`elaborator-reflection`.
8+
59Idris supports interactive theorem proving, and the analyse of context
610through holes. To list all unproven holes, use the command ``:m``.
711This will display their qualified names and the expected types. To
@@ -15,12 +19,12 @@ Basic commands
1519==============
1620
1721- ``:q`` - Quits the prover (gives up on proving current lemma).
18−- ``abandon`` - Same as :q
19−- ``state`` - Displays the current state of the proof.
20−- ``term`` - Displays the current proof term complete with its
22+- ``:abandon`` - Same as :q
23+- ``:state`` - Displays the current state of the proof.
24+- ``:term`` - Displays the current proof term complete with its
2125 yet-to-be-filled holes (is only really useful for debugging).
22−- ``undo`` - Undoes the last tactic.
23−- ``qed`` - Once the interactive theorem prover tells you "No more
26+- ``:undo`` - Undoes the last tactic.
27+- ``:qed`` - Once the interactive theorem prover tells you "No more
2428 goals," you get to type this in celebration! (Completes the proof and
2529 exits the prover)
2630