Skip to content

Commit 1a23297

Browse files
committed
Cleanup wrapping, whitespace, etc. in README.md
In `README.md`, some lines were hard wrapped where others were not, there was some trailing whitespace, and some list items were terminated with a period where some were not. Let's clean these things up by hard wrapping all lines, cleaning up the whitespace, and terminating all list items with periods.
1 parent 9104f17 commit 1a23297

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# The Rust Language Reference
22

3-
This document is the primary reference for the Rust programming language.
3+
This document is the primary reference for the Rust programming
4+
language.
45

56
This document is not normative. It may include details that are specific
67
to `rustc` itself, and should not be taken as a specification for the
@@ -10,15 +11,18 @@ what we have for now.
1011
## Dependencies
1112

1213
- rustc (the Rust compiler).
13-
- [mdbook](https://rust-lang.github.io/mdBook/) (use `cargo install mdbook` to install it).
14-
- rust nightly (you would be required to set your Rust version to the nightly version to make sure all tests pass)
14+
- [mdbook](https://rust-lang.github.io/mdBook/) (use `cargo install
15+
mdbook` to install it).
16+
- rust nightly (you would be required to set your Rust version to the
17+
nightly version to make sure all tests pass).
1518

1619
## Build steps
1720

18-
To build the project, follow the steps given below :
21+
To build the project, follow the steps given below:
1922

20-
Clone the project by downloading the ZIP from the [GitHub page](https://github.com/rust-lang/reference) or
21-
run the following command:
23+
Clone the project by downloading the ZIP from the [GitHub
24+
page](https://github.com/rust-lang/reference) or run the following
25+
command:
2226

2327
```
2428
git clone https://github.com/rust-lang/reference
@@ -30,21 +34,24 @@ Change the directory to the downloaded repository:
3034
cd reference
3135
```
3236

33-
To run the tests, you would need to set the Rust version to the nightly release. You can do this by executing the following command:
37+
To run the tests, you would need to set the Rust version to the nightly
38+
release. You can do this by executing the following command:
3439

3540
```shell
3641
rustup override set nightly
3742
```
3843

3944
This will set the nightly version only for your the current project.
4045

41-
If you wish to set Rust nightly for all your projects, you can run the command:
46+
If you wish to set Rust nightly for all your projects, you can run the
47+
command:
4248

4349
```shell
4450
rustup default nightly
4551
```
4652

47-
Now, run the following command to test the code snippets to catch compilation errors:
53+
Now, run the following command to test the code snippets to catch
54+
compilation errors:
4855

4956
```shell
5057
mdbook test

0 commit comments

Comments
 (0)