Skip to content

Commit 9bba152

Browse files
committed
Apply light edits to standard library links
1 parent 26f82aa commit 9bba152

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

reference-dev-guide/src/links.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Definition link: [namespace kinds]
2020

2121
## Standard library links
2222

23-
You should link to the standard library without specifying a URL in a fashion similar to [rustdoc intra-doc links][intra]. Some examples:
23+
You should link to the standard library without specifying a URL, in a fashion similar to [rustdoc intra-doc links][intra]. Some examples:
2424

2525
We can link to the page on `Option`:
2626

@@ -52,16 +52,16 @@ Explicit namespace disambiguation is also supported:
5252
[`std::vec`](mod@std::vec)
5353
```
5454

55-
Beware there are some limitations, for example:
55+
Beware of some limitations, for example:
5656

57-
- Links to rexports from `std_arch` don't work due to <https://github.com/rust-lang/rust/issues/96506>.
57+
- Links to re-exports from `std_arch` don't work due to <https://github.com/rust-lang/rust/issues/96506>.
5858
- Links to keywords aren't supported.
59-
- Links to trait impls where the trait is not in the prelude doesn't work. Traits must be in scope, and there currently isn't a way to add those.
59+
- Links to trait impls where the trait is not in the prelude don't work. Traits must be in scope, and currently there is no way to add them.
6060
- If there are multiple generic implementations, it will link to one randomly (see <https://github.com/rust-lang/rust/issues/76895>).
6161

6262
When running into a rustdoc limitation, consider manually linking to the correct page using a relative link. For example, `../std/arch/macro.is_x86_feature_detected.html`.
6363

64-
When rendering the Reference locally, by default it uses relative links to conform with how the books are published. This probably isn't what you want, so you usually will want to set the [`SPEC_RELATIVE=0` environment variable][rel] so that the links go to the live site instead.
64+
When rendering the Reference locally, it uses relative links by default to conform with how the books are published. This probably isn't what you want, so you will usually want to set the [`SPEC_RELATIVE=0` environment variable][rel] so that the links go to the live site instead.
6565

6666
[intra]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
6767
[rel]: tooling/building.md#spec_relative

0 commit comments

Comments
 (0)