Skip to content

Commit f1ae62f

Browse files
authored
various changes to the docs (exercism#149)
1 parent 254c57b commit f1ae62f

File tree

4 files changed

+11
-17
lines changed

4 files changed

+11
-17
lines changed

docs/INSTALLATION.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,4 @@
22

33
You can install Lean by following the [installation instructions][install] on the official website.
44

5-
The recommended way to install Lean is through **Visual Studio Code** and the **Lean 4 VS Code** extension.
6-
This extension automatically installs all required dependencies.
7-
It also includes syntax highlighting, code completion, version management, links to learning resources and documentation, and many other useful tools.
8-
9-
There are also alternative methods for [manual installation][manual-install], with support for some other editors.
10-
11-
You can also try out the language on the official [web playground][playground] without installing anything.
12-
13-
[install]: https://lean-lang.org/install/
14-
[manual-install]: https://lean-lang.org/install/manual/
15-
[playground]: https://live.lean-lang.org/
5+
[install]: https://lean-lang.org/instal

docs/LEARNING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For a more in-depth look at theorem proving in Lean, the book [Theorem Proving i
1010

1111
[The Lean Language Reference][lean-reference] is the authoritative source for detailed information about the language.
1212

13-
Many additional resources for learning Lean are made available by the community in [this repository][community-resources].
13+
Many additional resources for learning Lean are made available by the [Lean Community][community-resources].
1414

1515
[community-resources]: https://leanprover-community.github.io/learn.html
1616
[functional-programming]: https://lean-lang.org/functional_programming_in_lean/

docs/RESOURCES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Resources
22

33
* The [official site][lean-lang] is the main repository for content about the language.
4+
It has an online [playground][playground] where you can try out the language without installing anything.
45
* The [Reservoir][reservoir] indexes, builds and tests packages within the Lean and Lake ecosystem.
56
It is the place to go for third-party packages.
67
* [Lean Community][community] is a collaborative, open-source network around the Lean ecosystem.
78
It is responsible for _mathlib_, the main community-driven mathematics library for Lean 4.
89
* [Lean 4 Zulip Chat][zulip-chat] is the main chat for the Lean Community.
910

1011
[lean-lang]: https://lean-lang.org/
12+
[playground]: https://live.lean-lang.org/
1113
[reservoir]: https://reservoir.lean-lang.org/
1214
[community]: https://leanprover-community.github.io/index.html
1315
[zulip-chat]: https://leanprover.zulipchat.com/

docs/TESTS.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,25 +51,27 @@ All of them are expected to be defined in the solution module, within a namespac
5151
Each argument and the return value for each function has some type.
5252
This might be one of the basic types in Lean (for example, `Nat`, `List Int` or `Option String`), or a user-defined type.
5353

54-
You'll a find a file with the correct name already in place in the same folder as the test module.
54+
You will find a file with the correct name already in place in the same folder as the test module.
5555
This file should have a _stub_ with most initial informations, so that you can use it as a starting point for your solution.
5656

5757
Just keep in mind that this stub is there just for you to get started.
5858
Feel free to change it completely if you think it is the right thing to do.
5959

6060
## Using packages
6161

62-
Lean projects using Lake may always import the standard library `Std`, which contains additional data structures, IO and system APIs, and other basic utilities.
63-
This import should be at the beggining of the file:
62+
Lean projects using Lake may always import the standard library `Std`, which contains additional data structures, I/O and system APIs, and other basic utilities.
63+
This import should be at the beginning of the file:
6464

6565
```lean
6666
import Std
6767
6868
def someMap : Std.HashMap Int Nat := ...
6969
```
7070

71-
Note that the module name is its namespace, so in this example the type `HashMap` was qualified with `Std`, the package where it is defined.
72-
It is possible to open a module, so that all its data structures and functions are available without this namespace qualification:
71+
In this example, the type `HashMap` is qualified with `Std`, the namespace where it is defined.
72+
All resources in the standard library are in the same namespace, `Std`.
73+
74+
It is also possible to open a module so that all its data structures and functions are available without this namespace qualification:
7375

7476
```lean
7577
import Std

0 commit comments

Comments
 (0)