on master help sign in
rearrange documentation for elaborator reflection
commit840d3e40cff1a7ef14920200b3c3182bb132b58f authormartinbaker <git29f185@martinb.com> dateSat 14 Dec 2019, 16:14 (7 years ago) parent4d8d85d
10 files changed+44−14
docs/proofs/elabReflection.rst → docs/elaboratorReflection/elabReflection.rst docs/reference/elaborator-reflection.rst → docs/elaboratorReflection/elaborator-reflection.rst+6−5 docs/proofs/example1.rst → docs/elaboratorReflection/example1.rst docs/proofs/generatingData.rst → docs/elaboratorReflection/generatingData.rst docs/proofs/holes.rst → docs/elaboratorReflection/holes.rst docs/elaboratorReflection/index.rst+33 docs/proofs/primitive.rst → docs/elaboratorReflection/primitive.rst docs/proofs/tactics.rst → docs/elaboratorReflection/tactics.rst docs/index.rst+1 docs/proofs/index.rst+4−9
docs/proofs/elabReflection.rst → docs/elaboratorReflection/elabReflection.rstrenamed

The content is the same.

docs/reference/elaborator-reflection.rst → docs/elaboratorReflection/elaborator-reflection.rstrenamed+6−5
@@ -1,8 +1,8 @@
11.. _elaborator-reflection:
22
3−*********************
4−Elaborator Reflection
5−*********************
3+**********************************
4+Elaborator Reflection Introduction
5+**********************************
66
77The Idris elaborator is responsible for converting high-level Idris code into the core language.
88It is implemented as a kind of embedded tactic language in Haskell, where tactic scripts are written in an *elaboration monad* that provides error handling and a proof state.
@@ -198,6 +198,7 @@ This is primarily useful for code generation, particularly for generating patter
198198
199199Learn More
200200==========
201−While this documentation is still incomplete, elaboration reflection works in Idris today.
202−As you wait for the completion of the documentation, the list of built-in tactics can be obtained using the ``:browse`` command in an Idris REPL or the corresponding feature in one of the graphical IDE clients to explore the ``Language.Reflection.Elab.Tactics`` namespace.
201+Tactics are discussed in the proofs section.
202+
203+The list of built-in tactics can be obtained using the ``:browse`` command in an Idris REPL or the corresponding feature in one of the graphical IDE clients to explore the ``Language.Reflection.Elab.Tactics`` namespace.
203204All of the built-in tactics contain documentation strings.
docs/proofs/example1.rst → docs/elaboratorReflection/example1.rstrenamed

The content is the same.

docs/proofs/generatingData.rst → docs/elaboratorReflection/generatingData.rstrenamed

The content is the same.

docs/proofs/holes.rst → docs/elaboratorReflection/holes.rstrenamed

The content is the same.

docs/elaboratorReflection/index.rstnew file+33
@@ -0,0 +1,33 @@
1+.. _proofs-index:
2+
3+#########################################
4+Theorem Proving and Elaborator Reflection
5+#########################################
6+
7+A tutorial on theorem proving in Idris.
8+
9+.. note::
10+
11+ The documentation for Idris has been published under the Creative
12+ Commons CC0 License. As such to the extent possible under law, *The
13+ Idris Community* has waived all copyright and related or neighboring
14+ rights to Documentation for Idris.
15+
16+ More information concerning the CC0 can be found online at: http://creativecommons.org/publicdomain/zero/1.0/
17+
18+.. toctree::
19+ :maxdepth: 1
20+
21+ definitional
22+ pluscomm
23+ inductive
24+ patterns
25+ propositional
26+ interactive
27+ interactiveOld
28+ elabReflection
29+ tactics
30+ holes
31+ example1
32+ primitive
33+ generatingData
docs/proofs/primitive.rst → docs/elaboratorReflection/primitive.rstrenamed

The content is the same.

docs/proofs/tactics.rst → docs/elaboratorReflection/tactics.rstrenamed

The content is the same.

docs/index.rst+1
@@ -24,5 +24,6 @@ Documentation for the Idris Language
2424 st/index
2525 effects/index
2626 proofs/index
27+ elaboratorReflection/index
2728 reference/index
2829 guides/index
docs/proofs/index.rst+4−9
@@ -1,8 +1,8 @@
11.. _proofs-index:
22
3−#########################################
4−Theorem Proving and Elaborator Reflection
5−#########################################
3+###############
4+Theorem Proving
5+###############
66
77A tutorial on theorem proving in Idris.
88
@@ -25,9 +25,4 @@ A tutorial on theorem proving in Idris.
2525 propositional
2626 interactive
2727 interactiveOld
28− elabReflection
29− tactics
30− holes
31− example1
32− primitive
33− generatingData
28+