Commit Graph

141 Commits

Author SHA1 Message Date
Jeremy W. Sherman
056b307e7d Update running text to match code change
Forgot to update the description of what was printed on success
when I updated what was printed on success in both the code and the sample
output.
2015-08-08 15:10:01 -04:00
Jeremy W. Sherman
118d718a62 Restores self-documenting test output
Thanks @jfdm!
2015-08-08 15:06:42 -04:00
Jeremy W. Sherman
6411f5d2f2 Add example of running the tests
This lets the reader get the full experience of the example
and also shows the temporary file path by way of the type-checker output.

This does change the success/failure reporting text to match what I had
written, so I could copy verbatim from my terminal.

The previous success/failure messages had mismatched capitalization
(title case vs sentence case), but their verbosity might have been desirable
for a tutorial, however undesirable verbosity might be when scanning
test output.
2015-08-08 14:42:50 -04:00
Jeremy W. Sherman
b8808681d6 Fix testing example .ipkg syntax
Running it as it was written previously gave a couple errors:

    > idris --testpkg maths.ipkg
    Uncaught error: user error (maths.ipkg:1:1: error: expected: "package"
    module maths
    ^            )

    > idris --testpkg maths.ipkg
    Uncaught error: user error (maths.ipkg:3:1: error: expected: "executable",
        "libs", "main", "makefile",
        "modules", "objs", "opts",
        "sourcedir", "tests"
    module = Maths.NumOps
    ^                     )
2015-08-08 14:33:03 -04:00
Jeremy W. Sherman
b85b98f0d9 Caption code block with relative file paths
Even though I had read the ipkg section before this, it was not clear to me
that I needed to mirror the module structure on-disk in the directory
hierarchy. Providing this info to the reader removes that chance for confusion.
2015-08-08 14:28:01 -04:00
Jeremy W. Sherman
d1e9bf86c8 Rephrase intro to testing tutorial
Add verbiage to make clear that the test framework does no aggregration or
reporting in and of itself.
2015-08-08 14:24:13 -04:00
worldsayshi
b1ce657699 Fixed styling for multi line string literal docs 2015-07-30 00:31:17 +02:00
Niklas Larsson
bc4b4852e7 Merge pull request #2485 from worldsayshi/patch-1
Added docs on multiline strings
2015-07-30 00:26:58 +02:00
Niklas Larsson
7fe42e06de Merge pull request #2470 from benjamin-hodgson/2460_multipleFields
Multiple record fields on one line (#2460)
2015-07-30 00:26:43 +02:00
worldsayshi
f5e56a6c96 typo when correcting typo 2015-07-29 18:19:51 +02:00
worldsayshi
b6fd66302e added multi line strings doc and fixed typo 2015-07-29 18:12:21 +02:00
Niklas Larsson
af79c58c9c Merge pull request #2484 from melted/ops
Sync the documentation with opChars in ParseHelpers.hs
2015-07-29 12:55:08 +02:00
Niklas Larsson
a26562a666 Sync the documentation with opChars in ParseHelpers.hs
# and backslash was missing, and underscore isn't an operator char
2015-07-29 00:20:34 +02:00
Jan de Muijnck-Hughes
51bbaf91e8 Merge pull request #2480 from jeremy-w/jeremy-w/correct-mathsing-to-testing
Rewrite "mathsing" to "testing"
2015-07-28 09:38:57 +01:00
Jan de Muijnck-Hughes
c157e070a8 Merge pull request #2478 from jeremy-w/jeremy-w/updates-bst-module-reference-to-Btree
Update bst module reference to Btree
2015-07-28 09:38:32 +01:00
Jeremy W. Sherman
d03e2b018a Rewrite "mathsing" to "testing"
Looks like global search and replace changed "test" -> "maths" at some point.
2015-07-28 00:29:47 -04:00
Jeremy W. Sherman
0b8f521a84 Capitalize module name to match code sample
|btree| -> |Btree|
2015-07-28 00:06:09 -04:00
Jeremy W. Sherman
3ad394ec27 Update module name to |Btree| to match code sample
The code sample shows the module named |Btree| now.
|bst| was perhaps carried over from an older revision?
2015-07-27 23:59:00 -04:00
Jeremy W. Sherman
61fcd57244 Remove |splitAt| from let-binding section
|splitAt| is still introduced and discussed in the case expressions section.
Its appearance in the let-binding section looks like an accident.
2015-07-27 23:34:05 -04:00
Athan Clark
7fca841b31 Fixing typo 2015-07-27 17:49:11 -06:00
Benjamin Hodgson
9a9b797ce6 Add documentation for #2460 2015-07-26 16:45:55 +01:00
Niklas Larsson
fc4b908c80 List unavailable operators
Fixes #1162

There is already an error message for it
2015-07-24 13:17:00 +02:00
anthony cantor
f236bfffa3 make light of Data.Vect and Data.Fin imports in the interp example
the interp documentation section assumes that these types are in the
prelude.
2015-07-19 15:06:39 -07:00
David Raymond Christiansen
ec0b043055 Parser-driven highlighting of quasiquoted regions
Now, quasiquotation and antiquotation regions are annotated by the
parser, which can help editors.
2015-07-10 11:59:28 +02:00
David Christiansen
62bb3615f4 Merge pull request #2408 from mjgpy3/metavariable_to_hole_docs
Replace "metavariable" with "hole"
2015-07-08 01:10:05 +02:00
Jan de Muijnck-Hughes
1aa9f0b3dd Merge pull request #2394 from jfdm/doc/updates
Documentation Updates
2015-07-05 14:38:01 +01:00
Edwin Brady
83b839f6bc Bring effects summary up to date 2015-07-03 13:02:01 +01:00
Edwin Brady
2ac00791ff Bring effects tutorial up to date
Remove deprecated syntactic sugar, and an up to date version of pureM.
2015-07-03 12:57:42 +01:00
Michael Gilliland
696f336096 Replace "metavariable" with "hole" 2015-06-30 20:37:17 -04:00
Jan de Muijnck-Hughes
434dbabf7f Fix missing index contents 2015-06-29 14:28:36 +01:00
David Christiansen
28062bfdff Merge pull request #2385 from david-christiansen/issue/2356
Move mention of PATH earlier in tutorial
2015-06-28 18:31:14 +02:00
David Raymond Christiansen
9ba48848bf Add Windows path for Cabal to tutorial 2015-06-28 11:52:24 +02:00
Edwin Brady
63707440d7 Update docs for 'auto' 2015-06-26 19:42:58 +01:00
Jan de Muijnck-Hughes
18931a41bf Fixed naming error in test functions in tutorial. 2015-06-26 09:04:16 +01:00
Jan de Muijnck-Hughes
9f042575e1 Updates
+ Moved package listings to reference manual.
+ Added compact package description to tutorial.
+ Added section on testing idris packages.
2015-06-23 12:25:00 +01:00
Jan de Muijnck-Hughes
8b46d8f138 Updated package documentation. 2015-06-23 09:26:29 +01:00
Jan de Muijnck-Hughes
6923b5451a Fixed reST usage in elaborator reference.
Spaces needed to be added after a code block declaration e.g.

```reST

.. code-block:: idris

    data Nat = Z | (S Nat)

```
2015-06-23 08:36:41 +01:00
Jan de Muijnck-Hughes
4ac4488461 Updated package documentation.
+ Documented testing
+ Documented the complete CLI for packages.
2015-06-23 08:36:05 +01:00
David Raymond Christiansen
3275df6e23 Add :link-href to IDE mode docs 2015-06-22 12:33:01 +02:00
David Raymond Christiansen
d9d03c021f Move mention of PATH earlier in tutorial
RE #2356
2015-06-19 00:20:21 +02:00
Edwin Brady
f224681a7c Update FAQ
Differences with Agda question was somewhat out of date.
2015-06-14 12:04:58 +01:00
Thomas Cooper
36f37df7ff Fixed minor inconsistency in function definitions 2015-06-13 17:48:42 +01:00
David Raymond Christiansen
54cd5a62fe An interactive Elab shell
This mirrors the interactive prover, but it uses Elab tactics instead of
the old built-in tactic language.
2015-06-09 17:20:32 +02:00
David Raymond Christiansen
5542d1cfc5 Add maximum pretty-printer depth option.
The default is set to a high but finite number, so that accidentally
evaluating infinite things doesn't cause Idris to hang.

Fixes #2333.
2015-06-03 18:44:15 +02:00
Edwin Brady
fe4c09d346 Fix typos in semantic highlighting docs 2015-06-03 00:09:41 +02:00
David Raymond Christiansen
5db2080961 Initial elab reflection docs 2015-06-01 16:32:46 +02:00
David Raymond Christiansen
fa38cb582a Merge remote-tracking branch 'refs/remotes/upstream/master' into wip/tactical
Conflicts:
	docs/reference/index.rst
2015-06-01 14:17:31 +02:00
Jan de Muijnck-Hughes
37119ebbd9 Merge pull request #2332 from jfdm/doc/lang-reference-update
Reference Manual Improvements
2015-06-01 11:26:05 +01:00
Jan de Muijnck-Hughes
b75158a84f Merge pull request #2324 from jfdm/update/tutorial-pdf
PDF Tutorial Updates and Version Bump.
2015-06-01 11:23:59 +01:00
Andrei Dziahel
e7a4efe492 Update ide-protocol.rst
fixes inline code quoting
2015-06-01 11:19:11 +03:00