From db097f308af6b6ec219a460385159985256e2193 Mon Sep 17 00:00:00 2001 From: Kvicii <Karonazaba@gmail.com> Date: Thu, 27 Jan 2022 22:07:17 +0800 Subject: [PATCH 1/2] fix typo `documenation` --- src/doc/rustdoc/src/references.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/rustdoc/src/references.md b/src/doc/rustdoc/src/references.md index b0e2437392c95..bccc2f8e8fa90 100644 --- a/src/doc/rustdoc/src/references.md +++ b/src/doc/rustdoc/src/references.md @@ -16,7 +16,7 @@ If you know of other great resources, please submit a pull request! - [Github tagged RFCs] - [Github tagged issues] - [RFC (stalled) front page styleguide] -- [Guide on how to write documenation for a Rust crate] +- [Guide on how to write documentation for a Rust crate] [API Guidelines]: https://rust-lang.github.io/api-guidelines/documentation.html From ff79ce7e6fa0d65a208245d92857bf2c2a14599e Mon Sep 17 00:00:00 2001 From: Kvicii <Karonazaba@gmail.com> Date: Fri, 28 Jan 2022 10:26:49 +0800 Subject: [PATCH 2/2] fix typo `documenation` --- src/doc/rustdoc/src/references.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/rustdoc/src/references.md b/src/doc/rustdoc/src/references.md index bccc2f8e8fa90..45cf4e88eef6b 100644 --- a/src/doc/rustdoc/src/references.md +++ b/src/doc/rustdoc/src/references.md @@ -22,7 +22,7 @@ If you know of other great resources, please submit a pull request! [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 -[Guide on how to write documenation for a Rust crate]: https://blog.guillaume-gomez.fr/articles/2020-03-12+Guide+on+how+to+write+documentation+for+a+Rust+crate +[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 [RFC 1946: Intra Rustdoc Links]: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html