Commit Graph

253 Commits

Author SHA1 Message Date
Denis Buzdalov
46a2dc1c1f [ doc, tiny ] Correct wrong directive for unbound implicits turning off 2023-10-01 07:16:20 +01:00
Denis Buzdalov
b7bda5e96d [ docs ] Fix the formatting warning in the docs 2023-08-01 12:48:33 +01:00
André Videla
1fa638494d
[ new ] Fixity access modifier (#3011) 2023-07-31 08:35:16 +01:00
CodingCellist
51403ab18c
[ fix ] Only set IDRIS2_PREFIX if it is unset (fixes Issue 3022) (#3024) 2023-07-31 08:18:15 +01:00
Wilko Manger
870bc82437 Remove shadowed names in documentation 2023-07-21 15:38:34 +01:00
Noam Yorav-Raphael
d4a8c95fe3
Update docs copyright notice from 2020 to 2023 (#3001)
Co-authored-by: CodingCellist <teh6@st-andrews.ac.uk>
2023-07-05 16:39:12 +01:00
Andre Videla
9797a79b53 [ new ] Allow fixities to be hidden with %hide
* Change the printing of namespaced operator to show
  parenthesis around operators
* Update warning when conflicting fixities are found
* Do not warn about redundant but compatible fixities
2023-06-14 11:19:59 +01:00
Walter Smuts
e86420f710 Typos: specificy -> specify
Audit of "docs/" typos that did not have single match.
2023-06-08 13:41:58 +02:00
Walter Smuts
ab2d828887 Typos: Run 'typos -w' command over docs/
Only running over "docs/" directory since it will likely have the
largest postivie impact and cause fewest issues.

Typos will do simple find-and-replace when it detects a word not in it's
dictionary. It does not have any regard for formatting based on
surrounding context. Care must be taken not no merge variable names in
same scope etc.

Typos can be driven by Github Actions:
https://github.com/crate-ci/typos/blob/master/docs/github-action.md

Tool: https://github.com/crate-ci/typos
2023-06-08 13:41:54 +02:00
Leo
31c17ebec2
Add Pack to list of package managers (#2986)
* Add Pack to list of package managers

* Mention only Pack as package manager

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

---------

Co-authored-by: G. Allais <guillaume.allais@ens-lyon.org>
2023-06-02 07:27:12 +01:00
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