Skip to content

Commit e858736

Browse files
authored
Simplify English used in guide (#14825)
First draft of trying to simplify the English used in the guide section of the book, as well as normalising between 'you' for the reader and 'we' for the authors
2 parents ca3eb82 + e95c5a8 commit e858736

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/doc/src/guide/dependencies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To depend on a library hosted on [crates.io], add it to your `Cargo.toml`.
1313

1414
If your `Cargo.toml` doesn't already have a `[dependencies]` section, add
1515
that, then list the [crate][def-crate] name and version that you would like to
16-
use. This example adds a dependency of the `time` crate:
16+
use. This example adds a dependency on the `time` crate:
1717

1818
```toml
1919
[dependencies]
@@ -67,7 +67,7 @@ Our `Cargo.lock` contains the exact information about which revision of all of
6767
these dependencies we used.
6868

6969
Now, if `regex` gets updated, we will still build with the same revision until
70-
we choose to `cargo update`.
70+
we choose to run `cargo update`.
7171

7272
You can now use the `regex` library in `main.rs`.
7373

src/doc/src/guide/why-cargo-exists.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
In Rust, as you may know, a library or executable program is called a
66
[*crate*][def-crate]. Crates are compiled using the Rust compiler,
77
`rustc`. When starting with Rust, the first source code most people encounter
8-
is that of the venerable “hello world” program, which they compile by invoking
8+
is that of the classic “hello world” program, which they compile by invoking
99
`rustc` directly:
1010

1111
```console
@@ -18,15 +18,15 @@ Note that the above command required that we specify the file name
1818
explicitly. If we were to directly use `rustc` to compile a different program,
1919
a different command line invocation would be required. If we needed to specify
2020
any specific compiler flags or include external dependencies, then the
21-
needed command would be even more specific (and elaborate).
21+
needed command would be even more specific (and complex).
2222

2323
Furthermore, most non-trivial programs will likely have dependencies on
2424
external libraries, and will therefore also depend transitively on *their*
2525
dependencies. Obtaining the correct versions of all the necessary dependencies
26-
and keeping them up to date would be laborious and error-prone if done by
26+
and keeping them up to date would be hard and error-prone if done by
2727
hand.
2828

29-
Rather than work only with crates and `rustc`, we can avoid the manual tedium
29+
Rather than work only with crates and `rustc`, we can avoid the difficulties
3030
involved with performing the above tasks by introducing a higher-level
3131
["*package*"][def-package] abstraction and by using a
3232
[*package manager*][def-package-manager].
@@ -51,9 +51,9 @@ we show later, the same command can be used to build different
5151
[*artifacts*][def-artifact], regardless of their names. Rather than invoke
5252
`rustc` directly, we can instead invoke something generic such as `cargo
5353
build` and let cargo worry about constructing the correct `rustc`
54-
invocation. Furthermore, Cargo will automatically fetch from a
55-
[*registry*][def-registry] any dependencies we have defined for our artifact,
56-
and arrange for them to be incorporated into our build as needed.
54+
invocation. Furthermore, Cargo will automatically fetch any dependencies
55+
we have defined for our artifact from a [*registry*][def-registry],
56+
and arrange for them to be added into our build as needed.
5757

5858
It is only a slight exaggeration to say that once you know how to build one
5959
Cargo-based project, you know how to build *all* of them.

0 commit comments

Comments
 (0)