Skip to content

Commit

Permalink
Fix some wording in cargo-specifics.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss committed Jun 5, 2024
1 parent 88e81bc commit 964e885
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/doc/rustc/src/check-cfg/cargo-specifics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!--
This page is currently (as of May 2024) the canonical place for describing the interaction
between Cargo and --check-cfg. It is placed in the rustc book rather than the Cargo book
since check-cfg is primarely a Rust/rustc feature and is therefor consider by T-cargo to
since check-cfg is primarily a Rust/rustc feature and is therefore considered by T-cargo to
be an implementation detail, at least --check-cfg and the unexpected_cfgs are owned by
rustc, not Cargo.
-->
Expand All @@ -17,7 +17,7 @@ to the [Cargo book](../../cargo/index.html).

*See the [`[features]` section in the Cargo book][cargo-features] for more details.*

With the `[features]` table Cargo provides a mechanism to express conditional compilation and
With the `[features]` table, Cargo provides a mechanism to express conditional compilation and
optional dependencies. Cargo *automatically* declares corresponding cfgs for every feature as
expected.

Expand All @@ -32,12 +32,12 @@ my_feature = []

## `check-cfg` in `[lints.rust]` table

<!-- Note that T-Cargo considers `[lints.rust.unexpected_cfgs.check-cfg]` to be an
implementation detail and is therefor not documented in Cargo, we therefor do that ourself -->
<!-- Note that T-Cargo considers `lints.rust.unexpected_cfgs.check-cfg` to be an
implementation detail and is therefore documented here and not in Cargo. -->

*See the [`[lints]` section in the Cargo book][cargo-lints-table] for more details.*

When using a statically known custom config (ie. not dependant on a build-script), Cargo provides
When using a statically known custom config (i.e., not dependent on a build-script), Cargo provides
the custom lint config `check-cfg` under `[lints.rust.unexpected_cfgs]`.

It can be used to set custom static [`--check-cfg`](../check-cfg.md) args, it is mainly useful when
Expand Down

0 comments on commit 964e885

Please sign in to comment.