diff options
| author | jyn <github@jyn.dev> | 2023-04-26 01:55:51 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-26 01:55:51 -0500 |
| commit | 3163dfd1cd71487a5eb54d2f7c07bc2e1ef85d6a (patch) | |
| tree | 0461e63b752d50b518234256604100aed738b6b9 | |
| parent | a1d47188a72e9f747dd902e7c02a2ef93615c63f (diff) | |
| parent | b9b48e792e1ba74dcb8ed8a0621b140ca3fc8080 (diff) | |
| download | rust-3163dfd1cd71487a5eb54d2f7c07bc2e1ef85d6a.tar.gz rust-3163dfd1cd71487a5eb54d2f7c07bc2e1ef85d6a.zip | |
Rollup merge of #110418 - jsoref:spelling-rustdoc, r=jyn514
Spelling rustdoc Split per https://github.com/rust-lang/rust/pull/110392#issuecomment-1510148682
| -rw-r--r-- | src/doc/rustdoc/src/how-to-read-rustdoc.md | 2 | ||||
| -rw-r--r-- | src/doc/rustdoc/src/references.md | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/src/doc/rustdoc/src/how-to-read-rustdoc.md b/src/doc/rustdoc/src/how-to-read-rustdoc.md index 56342f65d99..393192af01e 100644 --- a/src/doc/rustdoc/src/how-to-read-rustdoc.md +++ b/src/doc/rustdoc/src/how-to-read-rustdoc.md @@ -43,7 +43,7 @@ including automatic and blanket implementations that `rustdoc` knows about. Subheadings, variants, fields, and many other things in this documentation are anchors and can be clicked on and deep-linked to, which is a great way to communicate exactly what you're talking about. -The typograpical character "§" appears next to lines with anchors on them +The typographical character "§" appears next to lines with anchors on them when hovered or given keyboard focus. ## The Navigation Bar diff --git a/src/doc/rustdoc/src/references.md b/src/doc/rustdoc/src/references.md index 45cf4e88eef..2e0cb1c0af4 100644 --- a/src/doc/rustdoc/src/references.md +++ b/src/doc/rustdoc/src/references.md @@ -13,15 +13,15 @@ If you know of other great resources, please submit a pull request! ## Community - [API Guidelines] -- [Github tagged RFCs] -- [Github tagged issues] +- [GitHub tagged RFCs] +- [GitHub tagged issues] - [RFC (stalled) front page styleguide] - [Guide on how to write documentation for a Rust crate] [API Guidelines]: https://rust-lang.github.io/api-guidelines/documentation.html -[Github tagged RFCs]: https://github.com/rust-lang/rfcs/issues?q=label%3AT-rustdoc -[Github tagged issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AT-rustdoc +[GitHub tagged RFCs]: https://github.com/rust-lang/rfcs/issues?q=label%3AT-rustdoc +[GitHub tagged issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AT-rustdoc [Guide on how to write documentation for a Rust crate]: https://blog.guillaume-gomez.fr/articles/2020-03-12+Guide+on+how+to+write+documentation+for+a+Rust+crate [Learn Rust]: https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments [RFC 1574: More API Documentation Conventions]: https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html |