Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed small typos #10693

Merged
merged 6 commits into from
May 23, 2022
Merged

Fixed small typos #10693

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6c5fac
Typos
alex-semenyuk May 21, 2022
14154d1
Update semver.md
alex-semenyuk May 22, 2022
aa77159
Update cargo-run.md
alex-semenyuk May 22, 2022
acbb3ca
Update faq.md
alex-semenyuk May 22, 2022
9dc393e
Update faq.md
alex-semenyuk May 22, 2022
d48a773
Reverted option
alex-semenyuk May 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ for more details.

<dl>

<dt class="option-term" id="option-cargo-run--F"><a class="option-anchor" href="#option-cargo-run--F"></a><code>-F</code> <em>features</em></dt>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change doesn't seem to be correct. The flag is uppercase.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ehuss Maybe make sense to remove it, because this option is not mentioned at doc https://doc.rust-lang.org/stable/cargo/commands/cargo-run.html and I don't see it at cargo 1.60.0 (d1fd9fe 2022-03-01) (see just --features)

Copy link
Contributor

@ehuss ehuss May 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a new flag, added in 1.62. The code here has not yet reached stable. You can view the nightly docs by adding nightly to the url like: https://doc.rust-lang.org/nightly/cargo/commands/cargo-run.html

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ehuss Ok, reverted. Curious, is there reason why all options are lowercase and just this is uppercase?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are other uppercase options like -Z and -V. I think uppercase -F was chosen to avoid possible confusion with lowercase -f which is often used to mean --force or --file in many unix utilities.

<dt class="option-term" id="option-cargo-run--f"><a class="option-anchor" href="#option-cargo-run--f"></a><code>-f</code> <em>features</em></dt>
<dt class="option-term" id="option-cargo-run---features"><a class="option-anchor" href="#option-cargo-run---features"></a><code>--features</code> <em>features</em></dt>
<dd class="option-desc">Space or comma separated list of features to activate. Features of workspace
members may be enabled with <code>package-name/feature-name</code> syntax. This flag may
Expand Down
9 changes: 5 additions & 4 deletions src/doc/src/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
### Is the plan to use GitHub as a package repository?

No. The plan for Cargo is to use [crates.io], like npm or Rubygems do with
npmjs.org and rubygems.org.
[npmjs.com][1] and [rubygems.org][3].

We plan to support git repositories as a source of packages forever,
because they can be used for early development and temporary patches,
Expand All @@ -23,8 +23,9 @@ central registry model as well as a Git-based model, and most packages
are downloaded through the registry in those ecosystems, with an
important minority of packages making use of git-based packages.

[1]: https://www.npmjs.org
[1]: https://www.npmjs.com
[2]: https://bundler.io
[3]: https://rubygems.org

Some of the advantages that make a central registry popular in other
languages include:
Expand Down Expand Up @@ -135,9 +136,9 @@ picture to decide what versions of dependencies should be used.
with wildcard dependency constraints.**

While libraries _can_, strictly speaking, they should not. A version requirement
of `*` says “This will work with every version ever,” which is never going
of `*` says “This will work with every version ever”, which is never going
to be true. Libraries should always specify the range that they do work with,
even if it’s something as general as “every 1.x.y version.”
even if it’s something as general as “every 1.x.y version”.

### Why `Cargo.toml`?

Expand Down
6 changes: 3 additions & 3 deletions src/doc/src/reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ Can be overridden with the `--target-dir` CLI option.
* Default: none
* Environment: `CARGO_BUILD_RUSTFLAGS` or `CARGO_ENCODED_RUSTFLAGS` or `RUSTFLAGS`

Extra command-line flags to pass to `rustc`. The value may be a array of
Extra command-line flags to pass to `rustc`. The value may be an array of
strings or a space-separated string.

There are four mutually exclusive sources of extra flags. They are checked in
Expand Down Expand Up @@ -402,7 +402,7 @@ appropriate profile setting.
* Default: none
* Environment: `CARGO_BUILD_RUSTDOCFLAGS` or `CARGO_ENCODED_RUSTDOCFLAGS` or `RUSTDOCFLAGS`

Extra command-line flags to pass to `rustdoc`. The value may be a array of
Extra command-line flags to pass to `rustdoc`. The value may be an array of
strings or a space-separated string.

There are three mutually exclusive sources of extra flags. They are checked in
Expand Down Expand Up @@ -974,7 +974,7 @@ the `<triple>` will take precedence. It is an error if more than one
* Environment: `CARGO_TARGET_<triple>_RUSTFLAGS`

Passes a set of custom flags to the compiler for this `<triple>`. The value
may be a array of strings or a space-separated string.
may be an array of strings or a space-separated string.

See [`build.rustflags`](#buildrustflags) for more details on the different
ways to specific extra flags.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/reference/semver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,7 @@ explicit type arguments.
<a id="fn-generalize-compatible"></a>
### Minor: generalizing a function to use generics (supporting original type)

The type of an parameter to a function, or its return value, can be
The type of a parameter to a function, or its return value, can be
*generalized* to use generics, including by introducing a new type parameter,
as long as it can be instantiated to the original type. For example, the
following changes are allowed:
Expand Down