Commit Graph

283 Commits

Author SHA1 Message Date
Stefano Volpe
12c4a94bc2
fix: typos in "Types and Functions" 2024-04-12 22:04:22 +00:00
Steve Dunham
388fe83bdc
[ doc ] document %cg pragma (#3217)
* [ doc ] document %cg pragma

* [ doc ] add more detail to %cg documentation
2024-03-17 10:40:07 +00:00
André Videla
7c70762f25 fix typos 2024-02-24 12:36:44 +00:00
André Videla
2859fcee08 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
93de3e0e07 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
e7a4914f11 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
e1f4fbba83 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
23b2ddd179 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
b22c7f8289 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
ef0ca76b4c Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
c4c79c9115 Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
bcb225568a Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
c6fbd27c6c Update docs/source/reference/operators.rst 2024-02-24 12:36:44 +00:00
André Videla
eb9d4d65a5 fix typo in doc 2024-02-24 12:28:10 +00:00
Andre Videla
c3651509e0 add operator documentation 2024-02-24 12:28:10 +00:00
Andre Videla
3d2c854257 update docs 2024-02-24 12:28:10 +00:00
Joel Berkeley
11968b7d5c
Update website FAQ on package managers (#3213)
* Improve website FAQ
2024-02-12 11:34:26 -06:00
Computer Dream
b30e0c4fd3
Update starting.rst 2024-01-21 14:28:35 +02:00
Stefano Volpe
bd9664ac8a
fix: singing dragon link
YouTube removed the original video. Added the archive.org version.
2024-01-13 19:37:30 +01:00
Thomas E. Hansen
ea180d0721 [ rc ] Prepare for 0.7.0
A lot more sensible all around  : )
2023-12-22 14:44:30 +01:00
Thomas E. Hansen
a3b078cb0d [ rc ] For v0.6.9 - to see if the process was right
Good luck everybody...

v0.6.9 - Nice!  ^^
2023-12-22 14:44:30 +01:00
André Videla
58e5d15662
Merge pull request #3162 from AdamHarries/compilerEnvs
[fix] correctly pass environment vars to the RefC compiler
2023-12-20 06:40:16 -05:00
Adam Brouwers-Harries
ecfe1bde70 use in cccompilerTest, correctly set DYLD_LIBRARY_PATH, use idrisGetEnv in CC.idr and update envvars documentation 2023-12-13 15:21:41 +00:00
Adam Brouwers-Harries
4cb45daba4 [doc] add note regarding C header inclusion to FFI documentation 2023-12-13 07:35:29 -06:00
Steve Dunham
60ec783483 [ doc ] updates to hint documentation. 2023-11-23 14:28:15 -08:00
Steve Dunham
a03c3bf376 [ doc ] Add missing pragmas to documentation 2023-11-22 09:13:42 -08:00
Joel Berkeley
e66b79fc2c mention Node version requirement 2023-11-10 13:09:27 +00:00
Thomas E. Hansen
db87cef0ad [ doc ] Headings for envvars based on use-time
Some envvars are only used at build-time, some only at runtime, and lots
are used at both. This clearly cagetorises them accordingly in the docs.
2023-11-01 09:41:22 +00:00
Mathew Polzin
7b0a1b4013 Update ffi.rst 2023-10-30 17:29:20 -05:00
CodingCellist
fcecb165b9
[ doc ] Document failing blocks (#3114) 2023-10-23 11:40:18 +01:00
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