lean4-htt/doc
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
..
bin chore(src/emacs): move lean-mode to https://github.com/leanprover/lean-mode 2017-10-06 10:46:43 -07:00
dev doc: update the mdbook instructions (#1521) 2022-09-03 11:08:38 +02:00
examples doc: explain acronym 2022-08-12 10:28:49 +02:00
images doc: add documentation on monads (#1505) 2022-09-05 13:33:15 -07:00
latex chore: prune ancient keywords 2022-08-01 13:32:56 +02:00
make chore: Nix: fix stage0-from-input 2022-06-27 22:37:02 +02:00
monads doc: add documentation on monads (#1505) 2022-09-05 13:33:15 -07:00
.gitignore doc: mdbook init 2020-10-30 14:23:47 +01:00
alectryon.css doc: fix overwide view when using Alectryon 2022-06-23 18:23:28 +02:00
alectryon.js doc: embed examples into doc book 2022-04-06 09:06:49 -07:00
array.md doc: add new example 2022-07-09 17:04:08 -07:00
autobound.md chore: fix doc 2022-02-10 17:12:18 -08:00
book.toml doc: fold sub-chapters by default 2022-04-20 18:46:30 +02:00
bool.md chore: CRLF be gone 2021-11-09 09:49:09 +01:00
BoolExpr.lean chore: remove Bootstrap package 2022-09-02 16:39:03 -07:00
builtintypes.md doc: builtin types 2020-12-08 10:09:58 -08:00
char.md doc: builtin types 2020-12-08 10:09:58 -08:00
declarations.md doc: update lean 3 -> lean 4 in declarations.md 2022-09-03 08:35:37 -07:00
decltypes.md doc: fix typos 2021-03-07 15:06:02 +01:00
definitions.md doc: basic documentation 2020-11-18 18:47:22 -08:00
dep.md fix: docs 2021-06-29 22:14:16 -07:00
deptypes.md doc: add deptypes section 2020-12-07 13:58:52 -08:00
do.md doc: document some do block patterns/sugar 2022-02-07 20:50:15 +01:00
elaborators.md doc: clean up syntax ToC 2022-04-26 18:58:45 +02:00
enum.md doc: "enumerated types" section markdown fix 2021-05-06 17:04:51 +02:00
examples.md doc: embed examples into doc book 2022-04-06 09:06:49 -07:00
expressions.md chore: prune ancient keywords 2022-08-01 13:32:56 +02:00
faq.md doc: faq: bullet points look weird and are not anchors 2021-12-09 11:53:25 +01:00
flake.lock chore: update mdBook 2022-08-09 22:19:40 +02:00
flake.nix chore: Nix: renderLean/renderDir 2022-07-15 18:44:17 +02:00
float.md doc: builtin types 2020-12-08 10:09:58 -08:00
fplean.md chore: add link from Lean 4 manual to FP in Lean 2022-06-09 16:28:54 -07:00
funabst.md doc: minor edits 2020-12-22 18:54:57 +01:00
functions.md doc: restriction of partial functions 2022-03-24 15:01:50 -07:00
highlight.js chore: rename ac_refl to ac_rfl 2022-08-01 06:53:08 -07:00
implicit.md chore: prune ancient keywords 2022-08-01 13:32:56 +02:00
inductive.md chore: remove broken documentation 2022-03-22 15:52:13 -07:00
int.md doc: minor edits 2020-12-22 18:54:57 +01:00
introdef.md doc: add deptypes section 2020-12-07 13:58:52 -08:00
lean3changes.md chore: fix docs 2022-06-14 17:35:33 -07:00
lexical_structure.md doc: fix some syntax and link in the docs, and more 2021-10-10 11:36:43 +02:00
list.md doc: builtin types 2020-12-08 10:09:58 -08:00
macro_overview.md feat: always accept antiquotations, simplify quotDepth code 2022-04-06 19:43:07 +02:00
metaprogramming-arith.lean refactor: remove some unnecessary antiquotation kind annotations 2022-07-23 17:09:32 +02:00
metaprogramming-arith.md doc: metaprogramming-arith: deduplicate 2022-05-03 18:38:36 +02:00
mission.md doc: start porting reference manual 2021-08-27 19:30:08 -07:00
namespaces.md fix: namespaces.md 2020-11-20 07:56:53 -08:00
nat.md doc: typo 2021-01-10 10:51:00 +01:00
notation.md doc: missing word 2022-06-16 10:12:07 +02:00
option.md doc: builtin types 2020-12-08 10:09:58 -08:00
organization.md doc: implicit arguments 2020-12-07 16:12:16 -08:00
other_commands.md doc: fix some syntax and link in the docs, and more 2021-10-10 11:36:43 +02:00
perf.md doc: add basic perf documentation 2021-09-06 07:12:36 -07:00
pygments.css doc: add documentation on monads (#1505) 2022-09-05 13:33:15 -07:00
quickstart.md doc: add link to short quickstart video 2022-06-06 18:32:11 -07:00
sections.md doc: correct typo “command instruct” ->”command instructs” 2021-07-03 11:22:04 +02:00
setup.md doc: fix link 2022-08-01 13:03:54 +02:00
simptypes.md doc: minor edits 2020-12-22 18:54:57 +01:00
string.md doc: builtin types 2020-12-08 10:09:58 -08:00
stringinterp.md chore: cleaner structure/class syntax 2020-11-24 13:07:43 -08:00
struct.md doc: structure update 2021-12-15 11:48:46 +00:00
SUMMARY.md doc: add documentation on monads (#1505) 2022-09-05 13:33:15 -07:00
syntax.md doc: clean up syntax ToC 2022-04-26 18:58:45 +02:00
syntax_example.lean doc: fix example style 2022-04-22 16:26:16 +02:00
syntax_example.md doc: fix example style 2022-04-22 16:26:16 +02:00
syntax_examples.md doc: missing file 2022-04-20 19:13:53 +02:00
syntax_highlight_in_latex.md doc: fix minted example 2022-07-23 15:14:44 +02:00
tactics.md fix: documentation 2022-03-03 18:18:37 -08:00
task.md doc: builtin types 2020-12-08 10:09:58 -08:00
thunk.md doc: fix trivial typo 2022-01-09 10:19:26 +01:00
tour.md chore: style use · instead of . for lambda dot notation 2022-03-11 07:49:03 -08:00
tpil.md doc: proper TPIL link 2022-03-22 16:37:16 -07:00
typeclass.md feat: OfNat instance postprocessor 2022-07-30 08:35:45 -07:00
typeobjs.md doc: fix typos 2021-03-07 15:06:02 +01:00
types.md chore: CRLF be gone 2021-11-09 09:49:09 +01:00
uint.md doc: builtin types 2020-12-08 10:09:58 -08:00
unifhint.md doc: structures 2020-12-08 16:25:19 -08:00
using_lean.md doc: start porting reference manual 2021-08-27 19:30:08 -07:00
whatIsLean.md doc: add documentation on monads (#1505) 2022-09-05 13:33:15 -07:00