diff --git a/src/doc/src/faq.md b/src/doc/src/faq.md index a993deb1825..bae171b891e 100644 --- a/src/doc/src/faq.md +++ b/src/doc/src/faq.md @@ -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, @@ -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: @@ -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`? diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index 89e70754699..c2d8e665ef9 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -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 @@ -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 @@ -974,7 +974,7 @@ the `` will take precedence. It is an error if more than one * Environment: `CARGO_TARGET__RUSTFLAGS` Passes a set of custom flags to the compiler for this ``. 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. diff --git a/src/doc/src/reference/semver.md b/src/doc/src/reference/semver.md index 0404efdcfb2..ee6962eafa5 100644 --- a/src/doc/src/reference/semver.md +++ b/src/doc/src/reference/semver.md @@ -955,7 +955,7 @@ explicit type arguments. ### 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: