Commit graph

57 commits

Author SHA1 Message Date
David Thrane Christiansen
5fcd42d71a
chore: remove old language manual (#6401)
To avoid user confusion, there should be just one manual.

This PR deletes the old manual, adding a link to the new one; the
website config will redirect these pages to the corresponding new manual
content.
2024-12-16 14:37:16 +00:00
Scott Morrison
def564183c
feat: checklist for release process (#3536)
This is still WIP: the checklist for release candidates will get
finished as I do the release of `v4.7.0-rc1`.

---------

Co-authored-by: David Thrane Christiansen <david@davidchristiansen.dk>
2024-03-05 02:55:17 +00:00
Sebastian Ullrich
ea5b55b8f2
doc: remove Nix docs 2023-12-01 08:32:20 +00:00
Sebastian Ullrich
371fc8868a doc: move out Nix setup 2023-06-28 09:49:08 +01:00
David Thrane Christiansen
8b9fe9b6c2
doc: fix typo in manual ToC (#1790)
There was a typographical error in the manual's table of contents (the section itself and the filename did not have the mistake).
2022-10-30 02:52:16 +02:00
Leonardo de Moura
e44fd19074 doc: Semantic highlighting
Many thanks for Patrick Massot for providing the new section at
https://leanprover.zulipchat.com/#narrow/stream/270676-lean4/topic/semantic.20highlighting.20doc/near/294953547
2022-10-02 08:37:15 -07:00
Chris Lovett
cc95456639
doc: add documentation on monads (#1505)
* doc: add documentation on functors.

* fix: make comments green

* minor tweaks

* doc: add section on Applicatives.

* doc: add some more info on the laws from Mario.

* doc: add law list and move lazy evaluation up so the chapter ends properly.

* doc: Add something on seqLeft and seqRight.

* doc: add section on monads.

* doc: fix some typos.

* doc: switch to LeanInk for chaper on Monads.

* doc: remove old files.

* doc: fix mdbook test errors.

* doc: add part 4: readers

* doc: add section on State monads

* doc: fix some typos and add some more details.

* doc: fix typos and add some CR feedback.

* doc: add Except monad section.

* doc: add info on monad transformers.

* Delete transformers.lean.md

* doc: fix some typos.

* doc: fix typos and move forward reference to monad lifting.

* doc: Update `State` to `StateM`

* doc: fix references to State to become StateM.

* doc: generalize indexOf implementation.

* doc: add chapter on monad laws and move "law" sections to this chapter to avoid redundancy.

* doc: add theorem

* Delete laws.lean.md

* doc: fix some typos.

* doc: fix broken link.

* doc: fox typos.

* fix: language changed from "us" to "you".

* doc: fix code review comments.

* doc: some word smithing

* doc: some word smithing and sample simplification.

* doc: add bad_option_map example.

* doc: add side note on `return` statement and fix heading level consistency.

* Add `withReader` info

* doc: change language from us, our, your, we, we'll, we've to "you"

* doc: add some forward links.

* doc: put spaces around colon in function  arguments like "(x : List Nat)"

* doc:
Add backticks on map
Remove commands on multiline structure instance
Fix centerdot
Add "one of"

* doc: Remove info about Functor in other languages.

* doc:
add info on <$> being left associative
remove another forward reference to monad
fix typo `operatoions`
remove unneccesary parens after <$>

* doc:
fix Type u -> Type v
fix you -> your
use `let val? ← IO.getEnv name`
in Readers call it "context" rather than "state".

* doc: fix withReader docs
use 'context' to describe the ReaderM state.
remove "trivial"
type inference => Lean
"abstract classes" => "abstract structures"
remove unnecessary parens

* doc: fix bug in explanation of `let x ← readerFunc2`
Fix explanation of equivalence between `def f (a : Nat) : String` and `def f : Nat → String`

* doc: move hasSomeItemGreaterThan to Except.lean
Add validateList List.anyM example.
fix `def f (a : Nat) : String` language.

* doc: fix "What transformation are you referring to"

* doc: fix typo.

* doc: add missing period.

* doc: fix validateList

* doc: explain `λ` notation.

* doc: reword the map, seq, bind comparison.

* doc: fix some more 'reader state' to 'reader context' language

* doc: fix wrote statement about return only works in do blocks.

* doc: fix typo

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

* doc: improve language

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

* doc: fix typo

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

* Add info on what a do block is doing for you.

* doc: define definitionally equal

* doc: make `readerFunc3.run env` canonical.

* doc: remove unnecessary parens.

* doc: fix typos

* doc: make List.map a bit more clear in the intro to Functors.

* doc: simplify readerFunc3WithReader

* doc: switch to svg for diagram so it works better on dark themes.

* doc: align nodes in diagram and convert to svg.

* doc: simplify playGame using while true.

* doc: drop confusing statement about "definitionally equal"

* doc: switch to `import Lean.Data.HashMap`

* doc: fix typo "operatoins"

* doc: update diagram to add more info and polish the intro paragraphs so they better match the actual contents of each chapter.

* doc: fix typo

* doc: fix typo.

Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>
2022-09-05 13:33:15 -07:00
Wojciech Nawrocki
72b9ba0dc5 chore: move tutorial to examples folder 2022-08-06 11:54:44 -07:00
E.W.Ayers
591b218607 doc: fix @kha issues 2022-07-25 08:01:27 -07:00
Leonardo de Moura
97e689d670 chore: add link from Lean 4 manual to FP in Lean 2022-06-09 16:28:54 -07:00
Sebastian Ullrich
3d2215c93c doc: clean up syntax ToC 2022-04-26 18:58:45 +02:00
Sebastian Ullrich
ca3f1a84b0 doc: fix example style 2022-04-22 16:26:16 +02:00
Leonardo de Moura
a5bf0d5ea5 chore: invert setup chapters by making the quickstart the default and the other one "extended setup notes" 2022-04-21 18:09:54 -07:00
Sebastian Ullrich
84cc167f95 doc: fix example code & style 2022-04-20 19:05:43 +02:00
Sebastian Ullrich
c354a9f62f doc: link orphan syntax tutorial 2022-04-20 18:49:38 +02:00
Sebastian Ullrich
2aaac3f94b doc: embed examples into doc book 2022-04-06 09:06:49 -07:00
Sebastian Ullrich
d2c626e158 doc: refine development manual 2022-04-05 16:03:24 +02:00
Sebastian Ullrich
adcdd16d7a doc: include missing chapter 2022-04-04 17:56:19 +02:00
Leonardo de Moura
6aee3fb304 chore: fix broken links 2022-04-03 10:32:00 -07:00
Leonardo de Moura
265803f7ac doc: fix links 2022-03-22 16:52:08 -07:00
Leonardo de Moura
e06893d1f2 doc: proper TPIL link 2022-03-22 16:37:16 -07:00
Leonardo de Moura
973b76a6e2 doc: add Examples section 2022-03-22 16:35:14 -07:00
Leonardo de Moura
5ae125262b chore: remove C++ coding style from manual 2022-03-22 15:54:51 -07:00
Leonardo de Moura
2e9adf0e04 chore: remove broken documentation 2022-03-22 15:52:13 -07:00
Andrei Cheremskoy
5eea97534f
chore(doc): remove duplicate Tactics section (#927) 2022-01-06 14:03:15 -08: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
c29ad9a9b3 doc: ubuntu: specify fewer versions that will become outdated anyway 2021-11-09 09:41:18 +01:00
Sebastian Ullrich
571fc66864 doc: ffi: move into dev/ 2021-10-29 08:46:31 -07:00
Sebastian Ullrich
627900ba9f doc: FFI 2021-10-29 08:46:31 -07: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
Leonardo de Moura
acfa2d7e78 doc: start porting reference manual 2021-08-27 19:30:08 -07:00
Sebastian Ullrich
ae9e608f98 doc: add quickstart to SUMMARY 2021-04-06 17:48:28 +02:00
Sebastian Ullrich
9485b8d074 doc: setup 2021-01-03 13:21:58 +01:00
Sebastian Ullrich
ca3dd82ed4 doc: notations & precedence 2020-12-28 00:44:16 +01:00
Sebastian Ullrich
c363019777 doc: notes on debugging Lean
/cc @leodemoura @javra
2020-12-21 17:49:59 +01:00
Leonardo de Moura
4d6b80cd51 doc: structures 2020-12-08 16:25:19 -08:00
Leonardo de Moura
1509a1ab18 doc: builtin types 2020-12-08 10:09:58 -08:00
Leonardo de Moura
eb11416edc doc: auto bound implicit arguments 2020-12-07 16:38:55 -08:00
Leonardo de Moura
d4c67a6bf0 doc: implicit arguments 2020-12-07 16:12:16 -08:00
Leonardo de Moura
021d5804f8 doc: add deptypes section 2020-12-07 13:58:52 -08:00
Leonardo de Moura
707ff44066 doc: Thunk
TODO: `Task` and support for threads
2020-11-29 10:19:27 -08:00
Leonardo de Moura
ee77afafa5 doc: add typeclass.md 2020-11-26 08:42:42 -08:00
Sebastian Ullrich
ffb8e1904b doc: Nix setup 2020-11-24 19:16:27 +01:00
Leonardo de Moura
d5c7f91b83 chore: reorg manual main page 2020-11-23 09:58:51 -08:00
Leonardo de Moura
a297d4107e doc: add tactics.md 2020-11-22 21:15:55 -08:00
Leonardo de Moura
9608ea5aef doc: do notation 2020-11-22 16:15:33 -08:00
Leonardo de Moura
b619f09010 doc: section, variables and namespaces 2020-11-19 17:34:08 -08:00
Leonardo de Moura
72a6ce498a chore: move lean3changes.md 2020-11-19 12:57:41 -08:00