Skip to content

Commit 56a3b7c

Browse files
authored
docs: improve language in root files (#2894)
I asked Gemini to review the English for inconsistencies and grammar mistakes. This is the result and I hope it's useful! As a non-native speaker, it is hard for me to evaluate the finer details, so let me know if you would like to see changes (or even better: make them directly in the PR with the suggestion function).
1 parent 9b4f561 commit 56a3b7c

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ Read the course at **https://google.github.io/comprehensive-rust/**.
1818

1919
## Course Format and Target Audience
2020

21-
The course is used internally at Google when teaching Rust to experienced
22-
software engineers. They typically have a background in C++ or Java.
23-
24-
The course is taught in a classroom setting and we hope it will be useful for
25-
others who want to teach Rust to their team. The course will be less useful for
26-
self-study since you miss out on the discussions happening in the classroom. You
27-
don't see the questions and answers and you don't see the compiler errors we
28-
trigger when going through the code samples. We hope to improve on this via
21+
The course is used internally at Google to teach Rust to experienced software
22+
engineers, typically with a background in C++ or Java.
23+
24+
The course is taught in a classroom setting, and we hope it will be useful for
25+
others who want to teach Rust to their team. The course is less ideal for
26+
self-study, since you would miss out on classroom discussions. You would not see
27+
the questions and answers, nor the compiler errors we trigger when going through
28+
the code samples. We hope to improve the self-study experience via
2929
[speaker notes](https://github.com/google/comprehensive-rust/issues/53) and by
3030
[publishing videos](https://github.com/google/comprehensive-rust/issues/52).
3131

@@ -44,7 +44,7 @@ Articles and blog posts from around the web which cover Comprehensive Rust:
4444
About how Microsoft, Google, and others are training people in Rust.
4545
- 2024-10-18:
4646
_[Rust Training at Scale | Rust Global @ RustConf 2024](https://youtu.be/7h5KyMqt2-Q?si=4M99HdWWxMaqN8Zr)_.
47-
What Google learnt from teaching Comprehensive Rust for more than two years.
47+
What Google learned from teaching Comprehensive Rust for more than two years.
4848

4949
## Setup
5050

@@ -57,7 +57,7 @@ The course is built using a few tools:
5757
- [mdbook-course](mdbook-course/)
5858
- [mdbook-linkcheck2](https://github.com/marxin/mdbook-linkcheck2)
5959

60-
First install Rust by following the instructions on https://rustup.rs/. Then
60+
First, install Rust by following the instructions on https://rustup.rs/. Then
6161
clone this repository:
6262

6363
```shell
@@ -93,8 +93,8 @@ Here are some of the commonly used commands you can run in the project. Run
9393
9494
## Contributing
9595

96-
We would like to receive your contributions. Please see
97-
[CONTRIBUTING.md](CONTRIBUTING.md) for details.
96+
We welcome contributions. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for
97+
details.
9898

9999
## Contact
100100

src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Building on this, you're invited to dive into one or more specialized topics:
3232

3333
- [Android](android.md): a half-day course on using Rust for Android platform
3434
development (AOSP). This includes interoperability with C, C++, and Java.
35-
- [Chromium](chromium.md): a half-day course on using Rust within Chromium based
35+
- [Chromium](chromium.md): a half-day course on using Rust in Chromium-based
3636
browsers. This includes interoperability with C++ and how to include
3737
third-party crates in Chromium.
3838
- [Bare-metal](bare-metal.md): a whole-day class on using Rust for bare-metal

src/welcome-day-1.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ Please remind the students that:
2626
- They should ask questions when they get them, don't save them to the end.
2727
- The class is meant to be interactive and discussions are very much encouraged!
2828
- As an instructor, you should try to keep the discussions relevant, i.e.,
29-
keep the discussions related to how Rust does things vs some other language.
30-
It can be hard to find the right balance, but err on the side of allowing
31-
discussions since they engage people much more than one-way communication.
29+
keep the discussions related to how Rust does things vs. some other
30+
language. It can be hard to find the right balance, but err on the side of
31+
allowing discussions since they engage people much more than one-way
32+
communication.
3233
- The questions will likely mean that we talk about things ahead of the slides.
3334
- This is perfectly okay! Repetition is an important part of learning.
3435
Remember that the slides are just a support and you are free to skip them as

0 commit comments

Comments
 (0)