Skip to content

Commit 2f8fa46

Browse files
committed
Small writing changes
1 parent d3a0c26 commit 2f8fa46

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

CHANGELOG.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,36 @@ You can enter it by entering `l` in the watch mode.
3232
It offers the following features:
3333

3434
- Browse all exercises and see their state (pending/done).
35-
- Filter exercises based on their state (done/pending).
35+
- Filter exercises based on their state (pending/done).
3636
- Continue at another exercise. This allows you to skip some exercises or go back to previous ones.
37-
- Reset an exercise so that you can start over and revert your changes.
37+
- Reset an exercise so you can start over and revert your changes.
3838

3939
### Solutions
4040

4141
After finishing an exercise, a solution file will be available and Rustlings will show you its path in green.
4242
This allows you to compare your solution with an idiomatic solution and maybe learn about other ways to solve a problem.
4343

44+
While writing the solutions, all exercises have been polished 🌟
45+
For example, every exercise now contains `TODO` comments to highlight what the user needs to change and where.
46+
4447
### LSP support out of the box
4548

46-
Instead of creating a `project.json` file using `rustlings lsp`, Rustlings now works with a `Cargo.toml` file.
49+
Instead of creating a `project.json` file using `rustlings lsp`, Rustlings now works with a `Cargo.toml` file out of the box.
50+
No actions are needed to activate the language server `rust-analyzer`.
51+
4752
This should avoid issues related to the language server or to running exercises, especially the ones with Clippy.
4853

4954
### Clippy
5055

51-
Clippy lints are now shown on all exercises! 📎
56+
Clippy lints are now shown on all exercises, not only the Clippy exercises 📎
5257
Make Clippy your friend from early on 🥰
5358

5459
### Third party exercises
5560

5661
Rustlings now supports third-party exercises!
5762

5863
Do you want to create your own set of Rustlings exercises to focus on some specific topic?
59-
Or did you want to translate the original Rustlings exercises?
64+
Or do you want to translate the original Rustlings exercises?
6065
Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)!
6166

6267
<a name="5.6.1"></a>

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Continue practicing your Rust skills by building your own projects, contributing
123123
## Third-Party Exercises
124124

125125
Do you want to create your own set of Rustlings exercises to focus on some specific topic?
126-
Or did you want to translate the original Rustlings exercises?
126+
Or do you want to translate the original Rustlings exercises?
127127
Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)!
128128

129129
## Uninstalling Rustlings

THIRD_PARTY_EXERCISES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Third-Party Exercises
22

33
The support of Rustlings for third-party exercises allows you to create your own set of Rustlings exercises to focus on some specific topic.
4-
You could also offer a translatation of the original Rustlings exercises as a third-party exercises.
4+
You could also offer a translatation of the original Rustlings exercises as third-party exercises.
55

66
## Getting started
77

88
To create third-party exercises, install Rustlings and run `rustlings dev new PROJECT_NAME`.
99
This command will, similar to `cargo new PROJECT_NAME`, create a template directory called `PROJECT_NAME` with all what you need to get started.
1010

11-
Read the comments in the generated `info.toml` file to understand the format of this file.
11+
Read the comments in the generated `info.toml` file to understand its format.
1212
It allows you to set a custom welcome and final message and specify the metadata of every exercise.
1313

1414
## Create an exercise
@@ -46,8 +46,8 @@ Now, add more exercises and publish them as a Git repository.
4646
Users just have to clone that repository and run `rustlings` in it to start working on your set of exercises just like the official ones.
4747

4848
One difference to the official exercises is that the solution files will not be hidden until the user finishes an exercise.
49-
But you can trust the user to not look at the solution too early ;)
49+
But you can trust the users to not look at the solution too early 😉
5050

5151
## Share
5252

53-
After publishing your set of exercises, open a pull request in the official Rustlings repository to link to your project in the README 😃
53+
After publishing your set of exercises, open an issue or a pull request in the official Rustlings repository to link to your project in the README 😃

0 commit comments

Comments
 (0)