Commit graph

589 commits

Author SHA1 Message Date
ammkrn
efb533fb24
doc: document some do block patterns/sugar 2022-02-07 20:50:15 +01:00
Sebastian Ullrich
a7ba103e0a chore: remove leanpkg 2022-02-04 19:03:40 +01:00
Leonardo de Moura
2bc5b8d1ec chore: remove doc/changes.md
In the last dev meeting, we have decided we are not going to use it.
We will release often (every month), and use pull requests and issues
to report changes.
2022-02-03 09:23:45 -08:00
Leonardo de Moura
9291f59c8f chore: add changes.md 2022-01-31 15:52:28 -08:00
Sebastian Ullrich
b20ecd02d7 chore: move out lean4-mode 2022-01-24 21:23:53 +01:00
Tom Ball
0b140ea451
doc: fix error in manual example
Co-authored-by: Tom Ball <you@example.com>
2022-01-22 10:03:32 +01:00
Sebastian Ullrich
f0f26728ed doc: more about initializers 2022-01-20 18:55:57 +01:00
Leonardo de Moura
98af42077c chore: fix doc 2022-01-16 09:28:03 -08:00
Josh Levine
1637d75d3f
doc: fix trivial typo 2022-01-09 10:19:26 +01:00
Andrei Cheremskoy
5eea97534f
chore(doc): remove duplicate Tactics section (#927) 2022-01-06 14:03:15 -08:00
ammkrn
f2cc9080a3 doc: document the split tactic 2022-01-04 13:28:36 -08:00
gabriel-doriath-dohler
6986032b38 doc: correct the link to "Lean Together 2021: Metaprogramming in Lean 4 continued" 2022-01-03 07:06:04 -08:00
Chris Lovett
c3a9860dc8 doc: replace leanpkg info with info about Lake
Fixes #789
2021-12-19 17:23:25 +01:00
Sebastian Ullrich
167dccce0b chore: move Leanpkg.leanVersionString to Init 2021-12-18 10:59:37 -08:00
Mario Carneiro
f17064809c fix doctest 2021-12-18 10:58:57 -08:00
Siddharth
37982c6d5c
doc: structure update
Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>
2021-12-15 11:48:46 +00:00
Leonardo de Moura
483f32edd8 feat: in pure code, do use assume Id monad at do notation
This feature produced counterintuitive behavior and confused users.
See discussion at #770.

As pointed out by @tydeu, it is not too much work to write `Id.run <|`
before the `do` when we want to use the `do` notation in pure code.

closes #770
2021-12-10 12:55:14 -08:00
Sebastian Ullrich
265c18accd doc: faq: bullet points look weird and are not anchors 2021-12-09 11:53:25 +01:00
Sebastian Ullrich
45917f2f90 chore: Nix: simplify package instructions 2021-12-04 12:14:47 +01:00
ammkrn
80c04c562a doc: add/edit macro guide
Incorporate review changes to the doc book suggested by Kha.
2021-11-22 11:02:07 +01:00
ammkrn
7539799976 doc: add macro guide, light reorganizing
Sebastian suggested moving the macro guide from Mathlib4 upstream into the Lean 4 manual (called `macro_overview.md` here). There was some discussion about where to put it; the section on metaprogramming seemed like the most appropriate place. I did a little bit of reorganizing to make some items more discoverable (e.g. the user-defined notation section).
2021-11-22 11:02:07 +01:00
Sebastian Ullrich
dbdb92a411 doc: advise using Developer Mode on Windows 2021-11-19 10:09:26 +01:00
Sebastian Ullrich
c5b6968c86 chore: symlink to source from build dir 2021-11-19 10:09:26 +01:00
Leonardo de Moura
47956b9b9e chore: fix test 2021-11-15 18:47:25 -08:00
Leonardo de Moura
c67541570f fix: fixes #787 2021-11-15 18:31:57 -08:00
Sebastian Ullrich
941b4c21e0 chore: CRLF be gone 2021-11-09 09:49:09 +01:00
Sebastian Ullrich
c29ad9a9b3 doc: ubuntu: specify fewer versions that will become outdated anyway 2021-11-09 09:41:18 +01:00
Sebastian Ullrich
b2f331f502 doc: --load-dynlib 2021-11-04 15:32:07 -07:00
Sebastian Ullrich
571fc66864 doc: ffi: move into dev/ 2021-10-29 08:46:31 -07:00
Sebastian Ullrich
81dca2ceb8 doc: ffi: address review 2021-10-29 08:46:31 -07:00
Sebastian Ullrich
627900ba9f doc: FFI 2021-10-29 08:46:31 -07:00
Sebastian Ullrich
40cf61f67b doc: very important clarification 2021-10-29 07:52:48 -07:00
Sebastian Ullrich
436b31b83c doc: quickstart: updated Windows instructions 2021-10-22 09:57:07 +02:00
Sebastian Ullrich
51a41705cb feat: allow more atoms starting with "`" 2021-10-19 14:10:31 +02:00
Sebastian Ullrich
7a91c494b9 chore: submodule hints 2021-10-15 06:56:02 -07:00
Sebastian Ullrich
74b813fbcd doc: restructure make/index.md
debug builds are not very interesting currently given the state of
debugging Lean code
2021-10-15 06:56:02 -07:00
Siddharth
66fcfcce37
doc: tutorial on parsing the arithmetic grammar using macros
* add arith

* Fixup based on Sebastian's feedback

* style nits

* add explanation about parsing precedence

* add Sebastian's suggest test case

Add the test case into the example to make sure we parse a*b+c as well
as a+b*c correctly.

* grammar pass

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>

* use pretty arrows, 2 spaces, [Arith| ... ]

* typo: :+ and :* had sneaked back in

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Wojciech Nawrocki <wjnawrocki+gh@protonmail.com>

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Wojciech Nawrocki <wjnawrocki+gh@protonmail.com>

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Wojciech Nawrocki <wjnawrocki+gh@protonmail.com>

* Update doc/tutorial/metaprogramming-arith.md

Co-authored-by: Gabriel Ebner <gebner@gebner.org>

* move all #print to #check

Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>
Co-authored-by: Wojciech Nawrocki <wjnawrocki+gh@protonmail.com>
Co-authored-by: Gabriel Ebner <gebner@gebner.org>
2021-10-12 08:51:17 +02:00
Chris Lovett
2860ba96f5
doc: fix some syntax and link in the docs, and more 2021-10-10 11:36:43 +02:00
Sebastian Ullrich
db755b6081 doc: temp fix
/cc @leodemoura
2021-10-07 12:59:14 +02:00
Sebastian Ullrich
762304f8b7 doc: fix 2021-10-03 21:19:45 +02:00
Siddharth
4b1b76ae51 doc: add metaprogramming docs of Dyck grammar parsing.
* LEAN4 -> Lean 4; directive -> command

* directive -> command everywhere
2021-10-02 11:08:26 -07:00
Sebastian Ullrich
ee73ad9f23 chore: update mdBook fork 2021-09-30 13:02:39 +02:00
Chris Lovett
2ca4188fc3 doc: somehow wsl2.md was created so the page on https://leanprover.github.io/lean4/doc/make/wsl2.html is empty. This fixes that. 2021-09-23 23:26:35 +02:00
Chris Lovett
3a20b6be8a
doc: add wsl setup docs and reorganize a new "dev" folder 2021-09-23 09:21:39 +02:00
Chris Lovett
ad7c5b26a7
fix: UTF-8 file path support for lean on Windows
* fix msys2 windows build so the windows apps support utf-8 file paths.

* use windres to compile default-manifest.o

* windres is in binutils.

* stop modifying default-manifest.o

* copy to stage0

* fix semicolon joining of lists in add_custom_target

* undo changes to stage0 as per CR feedback.

* fix makefile

* fix: revert cmakelists.txt COMMAND_EXPAND_LISTS  change

* fix: msys2 dependencies

* add unit test for decoding UTF-8 chars to prove "lean.exe" can read utf-8 encoded files where utf-8 is also used in the file name.

* fix: utf-8 test by using windows-2022

* fix: do we really need cmake 3.11 or will 3.10 do?

* nope, really does require cmake 11.
2021-09-22 12:21:52 +02:00
Leonardo de Moura
fe66523e43 chore: fix doc 2021-09-16 10:32:00 -07:00
Chris Lovett
1591bb1640 doc: fix msys text based on code review feedback 2021-09-10 10:07:57 +02:00
Chris Lovett
bc3900cbb9 doc: small fixes 2021-09-07 19:19:58 -07:00
Leonardo de Moura
65509c5617 doc: add basic perf documentation 2021-09-06 07:12:36 -07:00
Leonardo de Moura
acfa2d7e78 doc: start porting reference manual 2021-08-27 19:30:08 -07:00