Skip to content

Commit f4898d7

Browse files
authored
Merge pull request #2772 from him2him2/fix-typos
Fix typos and capitalization across documentation
2 parents 10d7550 + caa0c0e commit f4898d7

21 files changed

Lines changed: 30 additions & 30 deletions

src/about-this-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ There are several parts to this guide:
1010
about building, debugging, profiling, etc.
1111
1. [Contributing to Rust][p2]:
1212
Contains information that should be useful no matter how you are contributing,
13-
about procedures for contribution, using git and Github, stabilizing features, etc.
13+
about procedures for contribution, using git and GitHub, stabilizing features, etc.
1414
1. [Bootstrapping][p3]:
1515
Describes how the Rust compiler builds itself using previous versions, including
1616
an introduction to the bootstrap process and debugging methods.

src/building/bootstrapping/what-bootstrapping-does.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ This flag has the following effects:
342342

343343
Code which does not use `-Z force-unstable-if-unmarked` should include the
344344
`#![feature(rustc_private)]` crate attribute to access these forced-unstable
345-
crates. This is needed for things which link `rustc` its self, such as `MIRI` or
345+
crates. This is needed for things which link `rustc` itself, such as `Miri` or
346346
`clippy`.
347347

348348
You can find more discussion about sysroots in:

src/building/suggested.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You can also include extensions within extensions recursively.
5656
**Note:** In the `include` field, the overriding logic follows a right-to-left order.
5757
For example,
5858
in `include = ["a.toml", "b.toml"]`, extension `b.toml` overrides `a.toml`.
59-
Also, parent extensions always overrides the inner ones.
59+
Also, parent extensions always override the inner ones.
6060

6161
## Configuring `rust-analyzer` for `rustc`
6262

src/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ When you resolve them, you should use `@rustbot` to mark it as `S-waiting-on-rev
324324
GitHub allows [closing issues using keywords][closing-keywords].
325325
This feature should be used to keep the issue tracker tidy.
326326
However, it is generally preferred
327-
to put the "closes #123" text in the PR description rather than the issue commit;
327+
to put the "closes #123" text in the PR description rather than the commit message;
328328
particularly during rebasing, citing the issue number in the commit can "spam"
329329
the issue in question.
330330

src/debugging-support-in-rustc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ trait for a type would be one of these interfaces (`DW_tag_interface` type). Als
216216
which it is implemented would describe all the interfaces this type implements. This requires a
217217
DWARF extension.
218218

219-
Issue on Github: [https://github.com/rust-lang/rust/issues/33014]
219+
Issue on GitHub: [https://github.com/rust-lang/rust/issues/33014]
220220

221221
## Typical process for a Debug Info change (LLVM)
222222

src/diagnostics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Guidelines for different diagnostic levels:
228228
The error or warning portion should *not* suggest how to fix the problem,
229229
only the "help" sub-diagnostic should.
230230

231-
- `note`: emitted to given more context and identify additional circumstances
231+
- `note`: emitted to give more context and identify additional circumstances
232232
and parts of the code that caused the warning or error. For example, the
233233
borrow checker will note any previous conflicting borrows.
234234

@@ -788,7 +788,7 @@ add_lint_group!(sess,
788788
```
789789

790790
This defines the `nonstandard_style` group which turns on the listed lints. A
791-
user can turn on these lints with a `!#[warn(nonstandard_style)]` attribute in
791+
user can turn on these lints with a `#![warn(nonstandard_style)]` attribute in
792792
the source code, or by passing `-W nonstandard-style` on the command line.
793793

794794
Some lint groups are created automatically in `LintStore::register_lints`. For instance,
@@ -944,7 +944,7 @@ You can filter on the following boolean flags:
944944
- `crate_local`: whether the code causing the trait bound to not be
945945
fulfilled is part of the user's crate. This is used to avoid suggesting
946946
code changes that would require modifying a dependency.
947-
- `direct`: whether this is an user-specified rather than derived obligation.
947+
- `direct`: whether this is a user-specified rather than derived obligation.
948948
- `from_desugaring`: whether we are in some kind of desugaring, like `?`
949949
or a `try` block for example. This flag can also be matched on, see below.
950950

src/git.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ to ensure that Git doesn't create merge commits when `git pull`ing, without
372372
needing to pass `--ff-only` or `--rebase` every time.
373373

374374
You can also `git push --force-with-lease` from main to double-check that your
375-
feature branches are in sync with their state on the Github side.
375+
feature branches are in sync with their state on the GitHub side.
376376

377377
## Advanced Rebasing
378378

@@ -494,7 +494,7 @@ to follow and understand.
494494

495495
### Hiding whitespace
496496

497-
Github has a button for disabling whitespace changes that may be useful.
497+
GitHub has a button for disabling whitespace changes that may be useful.
498498
You can also use `git diff -w origin/main` to view changes locally.
499499

500500
![hide whitespace](./img/github-whitespace-changes.png)
@@ -505,7 +505,7 @@ To checkout PRs locally, you can use `git fetch upstream pull/NNNNN/head && git
505505
FETCH_HEAD`.
506506

507507
You can also use github's cli tool.
508-
Github shows a button on PRs where you can copy-paste the command to check it out locally.
508+
GitHub shows a button on PRs where you can copy-paste the command to check it out locally.
509509
See <https://cli.github.com/> for more info.
510510

511511
![`gh` suggestion](./img/github-cli.png)
@@ -521,7 +521,7 @@ for more details.
521521

522522
### Moving large sections of code
523523

524-
Git and Github's default diff view for large moves *within* a file is quite poor; it will show each
524+
Git and GitHub's default diff view for large moves *within* a file is quite poor; it will show each
525525
line as deleted and each line as added, forcing you to compare each line yourself.
526526
Git has an option to show moved lines in a different color:
527527

@@ -562,7 +562,7 @@ Rust projects from within the `rust` repo.
562562
Examples include Rust's fork of
563563
`llvm-project`, `cargo`, and libraries like `stdarch` and `backtrace`.
564564

565-
Those projects are developed and maintained in an separate Git (and GitHub)
565+
Those projects are developed and maintained in a separate Git (and GitHub)
566566
repository, and they have their own Git history/commits, issue tracker and PRs.
567567
Submodules allow us to create some sort of embedded sub-repository inside the
568568
`rust` repository and use them like they were directories in the `rust` repository.

src/macro-expansion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ Here `$mvar` is called a _metavariable_. Unlike normal variables, rather than
468468
binding to a value _at runtime_, a metavariable binds _at compile time_ to a
469469
tree of _tokens_. A _token_ is a single "unit" of the grammar, such as an
470470
identifier (e.g. `foo`) or punctuation (e.g. `=>`). There are also other
471-
special tokens, such as `EOF`, which its self indicates that there are no more
471+
special tokens, such as `EOF`, which itself indicates that there are no more
472472
tokens. There are token trees resulting from the paired parentheses-like
473473
characters (`(`...`)`, `[`...`]`, and `{`...`}`) – they include the open and
474474
close and all the tokens in between (Rust requires that parentheses-like

src/notification-groups/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ that fits the notification group's criteria. If you are interested, you
1111
can then [claim the issue] and start working on it.
1212

1313
Of course, you don't have to wait for new issues to be tagged! If you
14-
prefer, you can use the Github label for a notification group to
14+
prefer, you can use the GitHub label for a notification group to
1515
search for existing issues that haven't been claimed yet.
1616

1717
[claim the issue]: https://forge.rust-lang.org/triagebot/issue-assignment.html
@@ -47,7 +47,7 @@ particularly those of **middle priority**:
4747
## Joining a notification group
4848

4949
To join a notification group, you just have to open a PR adding your
50-
Github username to the appropriate file in the Rust team repository.
50+
GitHub username to the appropriate file in the Rust team repository.
5151
See the "example PRs" below to get a precise idea and to identify the
5252
file to edit.
5353

src/notification-groups/apple.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Apple notification group
22

3-
**Github Labels:** [O-macos], [O-ios], [O-tvos], [O-watchos] and [O-visionos] <br>
3+
**GitHub Labels:** [O-macos], [O-ios], [O-tvos], [O-watchos] and [O-visionos] <br>
44
**Ping command:** `@rustbot ping apple`
55

66
This list will be used to ask for help both in diagnosing and testing

0 commit comments

Comments
 (0)