Commit Graph

293 Commits

Author SHA1 Message Date
Steve Dunham
360136ce25 [ doc ] Add correction to listing 6.9 in typedd.rst 2023-05-28 22:35:49 +01:00
Marshall Abrams
04c5531d9b Update typedd.rst
Re `cast` vs. `stringToNatOrZ` in the chapter 5 tip:

`cast` from `String` to `Nat` does work in Idris 2, version 0.6.0-a75161cb2, so the first sentence is not currently correct, and there is no change needed to make the code work.

In the Discord documentation channel, z_snail suggested changing the text to merely recommend changing `cast` to `stringToNatOrZ`.   This PR proposes that change.  I tried to change the text as little as possible, but I made some additional, strictly speaking unnecessary revisions, where I thought they would make the wording clearer given the essential changes.  I added a missing period as well.

(If the `cast` from `String` to `Nat` is destined to be removed, perhaps this PR should be ignored.)
2023-05-20 09:20:09 +01:00
Marshall Abrams
65569858fb Update typedd.rst: Chapter 5: new imports for exercises in 5.3.4
The instructions for the exercises at the end of section 5.3.4 list several file-handling functions needed for the exercises.  They were in the Prelude, but now are in `System.File.Handle` and `System.File.ReadWrite`, and I added a note about that.  (`import System.File` would work for the exercise code, but the docs aren't there, so I didn't mention that.  I also didn't mention there a few other definitions, in other modules, that one needs to look up to understand the functions that the book lists.  I think that figuring out that one needs to find those additional docs is supposed to be part of the exercise.)
2023-05-20 09:16:57 +01:00
Marshall Abrams
8aa08b5a83 Update typedd.rst: fixed typo in function name, added page ref
readNumber_v2 should be readNumbers_v2.  I also added a remark pointing to the corresponding function definition in the book, for people who prefer to type  in the definitions themselves (like me) rather than using the source files in the repo. 

There's another issue with the chapter 5 tips, but I'm not sure what the right fix is, so I'll submit an issue.
2023-05-15 08:42:35 +01:00
Marshall Abrams
3eeb4f4cd3
Added notes: :exec needs to be passed main (#2946) 2023-04-16 08:10:08 +01:00
Robert Walter
8120988a60
[ doc ] extend tutorial (#2897) 2023-03-28 10:27:23 +01:00
Alexander
68e4f19c50
Fix typo: Phase --> UsePhase 2023-02-06 23:52:41 +03:00
Alexander
09f97d673c
Fix typo 2023-02-06 20:55:25 +03:00
Alexander
304c29ed79 Fix typo 2023-01-08 12:44:19 +00:00
Mathew Polzin
63a22b819d
[docs] javascript FFIs and packaging of JS or C support files (#2842)
* Add documentation on javascript FFIs and packaging of JS or C support files.

* Add to changelog.

* line length

* add some detail about the install directories for packages.
2023-01-07 21:40:47 +00:00
Denis Buzdalov
2dfd7e5259 [ doc ] Minor syntactic correction in the code example 2022-12-20 16:36:27 +00:00
Sridhar Ratnakumar
9ab23c78bc docs: Fix link to libraries 2022-12-20 15:36:11 +00:00
Tim Engler
69f680e10a Update introapp.rst
Further explain why the App passed to ``run`` can't throw an exception.
2022-11-21 10:55:52 +00:00
Tim Engler
bff18428b4 Added seqL to Control.App and updated docs to fix #2761
Also updated test real002 to use the actual Control.App from
libs/base/Control/App.idr. Before it was using a different version that
existed within its test directory, tests/idris2/real002/Control/App.idr
2022-11-21 10:39:43 +00:00
Tim Engler
774529fd70 Altered docs for `Exception` to reflect the code changes in Control.App
Exception is no longer an interface but just a synonym of ``HasErr``. Updated docs to reflect this.
2022-11-13 09:28:43 +00:00
Edwin Brady
e125c9014f
Prepare release 0.6.0 (#2733)
* Prepare release 0.6.0

* Fix bootstrap chez

* Correct version in bootstrap chez
2022-10-27 16:32:16 +01:00
André Videla
fce45c5762
Merge pull request #2717 from MithicSpirit/main
Reduce ambiguity in dependent types `filter` example
2022-10-18 14:16:17 +01:00
tangcl
0b1874e4fd Change notId's definition 2022-10-16 20:34:50 +01:00
MithicSpirit
acd9c09a05
Reduce ambiguity in dependent types filter example
`p` was used for both the filter predicate and the length of the
filtered vector. This renames the latter to n'.
2022-10-16 00:44:54 -04:00
Thomas E. Hansen
ff6ffad907 fix formatting 2022-10-06 10:10:16 +02:00
Denis Buzdalov
693ed5543a [ doc, re #2193 ] Document expected behaviour of namespaces in functions 2022-10-06 10:10:16 +02:00
Nil Geisweiller
6709f7742a
Fix URL of External backends hyperlink. 2022-09-30 07:14:16 +03:00
Nil Geisweiller
e8b1e34f1c Add missing space after … 2022-09-08 09:22:47 +01:00
Mathew Polzin
50ae5f9484 fix syntax errors produced by case splitting 2022-08-16 09:23:19 +02:00
Guillaume Allais
4a465ac21e [ fix ] custom backend doc
The type Codegen was changed in #2594.
2022-07-26 15:33:46 +01:00
Steve Dunham
c69af04f46
[ fix ] Support multiple ide server instances (#2586)
* Print the bound ide mode socket instead of the configuration variable.

* Change --ide-mode-socket to choose an open socket instead of using 38398

* [ doc ] Documentation for starting ide-mode
2022-07-18 14:08:56 +01:00
Nil Geisweiller
da3239bdf5
Update packages.rst (#2588) 2022-07-13 06:25:37 -07:00
fetsorn
af04b00270 fix typo in interactive.rst 2022-05-31 09:36:05 +01:00
G. Allais
071d37197a
[ IDE ] intro command (#2502) 2022-05-27 10:54:34 +01:00
G. Allais
607a2a2110
[ IDE ] refine command (#2490) 2022-05-25 11:29:03 +01:00
Nil Geisweiller
7461c3f538 Fix typo: Calculutor -> Calculator 2022-05-19 11:50:48 +01:00
Thomas Dziedzic
8bd5ca9492
[ doc ] cookbook for parsing (#2484) 2022-05-18 13:17:12 +01:00
KDr2
e3f31d3542 fix a case typo in document 2022-05-10 08:27:24 +01:00
Denis Buzdalov
36837942d5 [ doc ] Refine text about rewrite clause 2022-04-22 20:37:56 +01:00
Zoe Stafford
0010768ee7
[doc] Rewrite docs for %builtin and nat optimisations (#2426) 2022-04-22 14:52:02 +01:00
ayaye
67951529e8
[ doc ] Proving Propositional Equality: example fixed (#2420) 2022-04-20 14:54:18 +01:00
Vit Brunner
3d7b946fb9 Fix links to GitHub wiki 2022-03-11 20:31:43 +01:00
Denis Buzdalov
9d93e74012 [ doc ] Fix prefix var, IDRIS2_PREFIX is used, not PREFIX 2022-03-10 14:25:16 +00:00
Marcus Granado
fbfde5f770 B is defined as proposition y=z 2022-02-15 14:17:01 +00:00
Trevor Arjeski
a2c7e9f306
Update TypeDD Chapter 11 for idris2 (#2296) 2022-01-30 20:49:26 -08:00
Robert Wright
dc25e8f694 Rename RefC extension function stubs 2022-01-20 11:27:30 +00:00
Mathew Polzin
e7ed760016
[ new ] optional language version field to ipkg files. (#2256) 2022-01-20 10:05:53 +00:00
Trevor Arjeski
0d58282087
Update typedd.rst - Exercise 2 of 8.2.5 (#2266) 2022-01-16 23:56:38 -08:00
Vincent de Haan
3a38424e69 Minor fix in documentation 2022-01-11 22:36:22 +01:00
Ohad Kammar
ade8034bd1
[ refactor ] More IDE protocol (#2238) 2022-01-06 10:09:29 +00:00
Denis Buzdalov
a09c5082c5
[ base ] Use Fin n as index in Bits (#2192) 2021-12-16 18:26:52 +00:00
teggot
d3aed0404c
[ fix #1959 ] use modern record update syntax (#2196) 2021-12-16 18:23:18 +00:00
Denis Buzdalov
a4eb8b2ec3 [ doc ] Fix a complain of not being in a toctree 2021-11-17 10:50:49 +00:00
Mathew Polzin
0eba4c691e
Add %deprecate pragma (#2086) 2021-11-17 10:41:03 +00:00
Kamil Shakirov
ae411fe756 [ doc ] Mark code blocks as Idris code 2021-11-11 18:55:11 +00:00
Zoe Stafford
3063218d46
[ new ] Add %nomangle (#2063)
This is (for once) not a breaking changes, instead backends will need to opt in to this change, using the utilities in Compiler.NoMangle. See the js backend for an example of how to do this.

This is the first step to being able to use idris to create libraries usable by other languages.
2021-11-09 16:23:50 +00:00
Greg Werbin
778fac7a8f
[ doc ] Add note about ExprSearch 2021-11-03 00:06:50 -04:00
Greg Werbin
4926ae3ab5
[ doc ] Clarify IDE Mode docs & adjust text 2021-11-03 00:06:50 -04:00
G. Allais
96c44abb64
[ new ] :doc for keywords (#2028)
* [ new ] :doc for keywords

* [ doc ] for visibility

* [ more ] fixing help text, sentence for "mutual"

* [ doc ] for if then else

* [ doc ] for implicit arguments

* [ doc ] import

* [ cleanup ] doc for data

* [ doc ] for record

* [ doc ] for forall quantifier

* [ doc ] for `in' keyword

* [ doc ] for parameters block

* [ fix ] missing fence

* [ doc ] for where and mutual blocks

* [ doc ] for namespace blocks

* [ doc ] for with/proof

* [ doc ] for do blocks

* [ doc ] for rewrite

* [ doc ] for let binding

* [ doc ] for case...of and interfaces

* [ doc ] for fixity
2021-10-26 18:58:06 +01:00
Denis Buzdalov
58103d9d44 [ doc ] Mark code examples as Idris code in implementation overview 2021-10-21 21:40:18 +01:00
André Videla
e4d566b28c
Update documentation and changelog for string interpolation (#2013)
* Update documentation and changelog for string interpolation

* Fix typo in changelog

* fix documentation about desugaring of interpolate

* Update CHANGELOG.md

Co-authored-by: G. Allais <guillaume.allais@ens-lyon.org>

Co-authored-by: G. Allais <guillaume.allais@ens-lyon.org>
2021-10-18 11:45:32 +01:00
André Videla
274954998b
Implement generic interpolation (#1967)
Co-authored-by: Guillaume ALLAIS <guillaume.allais@ens-lyon.org>
2021-10-13 17:26:54 +01:00
DrBearhands
7a4af0cad4 FIxed typo: repeated word 2021-10-13 14:25:32 +01:00
Alex Dikelsky
1ba3d8a84b
Backend cookbook rst and typo fixes (#1966) 2021-10-04 11:32:50 +01:00
Edwin Brady
1e90182311
Version increment to 0.5.1 (#1939)
This is to remove the requirement on Chez >9.5
2021-09-19 20:53:32 +01:00
Edwin Brady
ada3eb4449
Version 0.5.0 (#1931)
* Update version numbers and bootstrap scheme

* Use wall clock time for search timeouts

That was always the intention in any case, rather than the process time.
2021-09-18 16:07:34 +01:00
Guillaume ANDRIEU
71511f4bdd
code-blocks missing in the docs (#1911)
* Update strings.rst

For some reasons the code blocks which are not set as 'idris' are not displayed in the readthedocs rendering.

* Update overloadedlit.rst

* Update overloadedlit.rst
2021-09-08 18:46:46 +01:00
Guillaume ALLAIS
a7d73d0d3d [ new ] ellipses for with patterns
Rather than Agda's `...` we use the common symbol for "I don't care": `_`.
2021-08-31 22:50:46 +01:00
Peter Hajdu
2d7ddc6e64 [ fix #472 ] Port doc about comments from Idris1 2021-08-27 14:58:35 +01:00
Denis Buzdalov
377b21e376 [ doc ] Remove trailing spaces from doc files 2021-08-11 12:50:02 +01:00
Denis Buzdalov
150bffc307 [ doc ] Hopefully fix the linting problem in the docs 2021-08-10 15:11:32 +03:00
Mathew Polzin
b03395debe
Merge pull request #1603 from ska80/remove-realpath-notes
Remove all mentions of `realpath` from docs
2021-07-26 12:38:39 -07:00
Niklas Larsson
4b0edbaa4f Update windows docs with gotchas 2021-07-23 15:48:54 +02:00
Niklas Larsson
603c60efec Add some docs about building on Windows 2021-07-23 10:58:38 +01:00
Ellis Kesterton
e5879dc687 Document --init
Reference the --init option for creating package files in the tutorial documentation.
2021-07-22 19:15:33 +01:00
André Videla
440a3affd5
Update docs/source/reference/strings.rst
Co-authored-by: G. Allais <guillaume.allais@ens-lyon.org>
2021-07-19 10:37:22 +00:00
André Videla
396ebe2023 Add documentation for new string literals 2021-07-18 22:32:26 +00:00
André Videla
9aa7a4303a Added documentation for new string literals 2021-07-18 21:37:20 +00:00
Edwin Brady
d1b1ec04cf Minor FAQ edits 2021-07-18 21:03:12 +01:00
Niklas Larsson
ac595b1bb1 Fix link to chez-exe 2021-07-18 15:47:45 +02:00
Kenneth J Hughes
b663a06999 Update javascript.rst 2021-07-17 17:32:39 +01:00
Niklas Larsson
f8fc131b57
Merge pull request #1734 from melted/chez_exe
Add docs for chez-exe
2021-07-17 15:33:58 +02:00
Edwin Brady
877e830133 A couple of documentation corrections
A CHANGELOG update, and a correction on data type names which has been
wrong in the crash course for some time now!
2021-07-17 14:20:32 +01:00
Niklas Larsson
d4039d962c Add docs for chez-exe 2021-07-16 22:05:28 +02:00
Kamil Shakirov
c4b41ee1ff Remove all mentions of realpath from docs
`realpath` is no longer needed to run executables.
2021-07-16 21:20:11 +06:00
Edwin Brady
3ee965e30d FAQ/CONTRIBUTION updates
We had a lot of things missing here, and the contributing guidelines
were extremely out of date and reflected the state when I first made the
Idris 2 repo public. I've updated both to reflect the current state of
the way we work, and to give better guidelines about what will be most
helpful.
2021-07-16 11:16:46 +01:00
Edwin Brady
3c88c33f15
Merge pull request #1452 from nickdrozd/emacs-doc
Update Emacs idris-mode doc
2021-07-15 23:38:26 +01:00
stefan-hoeck
fdb2d4f2a4 [ doc ] updated javascript documentation 2021-07-13 11:15:20 +01:00
technic93
b5c2f28dae
Add comment about import from the contrib library (#1625) 2021-06-28 16:23:01 +01:00
Kamiλ Shakirov
8e30b296c0
[ refactor ] Remove Data.Strings module (#1607) 2021-06-28 13:48:37 +01:00
Edwin Brady
74f0c3bf33 Add some documentation on incremental builds 2021-06-27 17:03:16 +01:00
Edwin Brady
980b6174ec Added --mkdoc to CHANGELOG too 2021-06-23 18:31:31 +01:00
Edwin Brady
80aeecaac0 Add note on --mkdocs 2021-06-23 18:29:49 +01:00
Edwin Brady
ae73c39609 Merge github.com:idris-lang/Idris2 into prepare-040 2021-06-23 16:17:40 +01:00
Edwin Brady
a0cfa28621 Update version numbers 2021-06-23 16:15:21 +01:00
zseri
c760812b59 fix #1514 (Broken doc in the theorem proving part of Idris2) 2021-06-22 14:42:54 +02:00
Robert Wright
a8264f8f05 Add ability to extend RefC backend to create further backends 2021-06-18 16:59:35 +01:00
Alissa Tung
41c3fd2632
[docs] ind-ind ind-rec rec-rec in style of fwddecl (#1558)
Co-authored-by: G. Allais <guillaume.allais@ens-lyon.org>
2021-06-16 16:20:11 +01:00
Robert Wright
1875f62248 Remove freeBuffer function
Each backend is now responsible for freeing Buffers in the same way as other objects
2021-06-14 15:06:44 +01:00
Robert Wright
c63f25dac2 Distinguish common C and RefC FFI calls 2021-06-14 15:06:44 +01:00
Denis Buzdalov
2a4197e909
[ doc ] Some documentation on := syntax of let bindings (#1487)
Co-authored-by: Guillaume ALLAIS <guillaume.allais@ens-lyon.org>
2021-06-03 16:49:31 +01:00
Jan de Muijnck-Hughes
692054516e
A rough dump of how to debug idris2's workings. (#1464) 2021-05-26 10:19:40 +01:00
Kamiλ Shakirov
ad656a8d47
Remove realpath (#1457) 2021-05-25 11:01:28 +01:00
Nick Drozd
dc5c3963e4 Update Emacs idris-mode doc 2021-05-22 16:19:17 -05:00
Ohad Kammar
618c71477e
[ close #1384 ] built-in Snoc-lists [< 1, 2, 3 ] (#1383) 2021-05-20 12:56:25 +01:00