From ff11f5eef308a92693fda4812dca9ecd34a00afa Mon Sep 17 00:00:00 2001 From: follower Date: Sun, 27 Sep 2020 04:22:47 +1300 Subject: [PATCH 1/3] Add links to documentation sources. Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them. --- src/contributing.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 0415f8e08..ba446b274 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -373,10 +373,13 @@ the submodule to. Running `./x.py build` should work now. ## Writing Documentation Documentation improvements are very welcome. The source of `doc.rust-lang.org` -is located in `src/doc` in the tree, and standard API documentation is generated -from the source code itself. Documentation pull requests function in the same way +is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated +from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function in the same way as other pull requests. +[srcdoc]: https://github.com/rust-lang/rust/tree/master/src/doc +[librs]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1 + To find documentation-related issues, sort by the [T-doc label][tdoc]. [tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc From 8132163db43613a223a4baa6de5337a283fc066d Mon Sep 17 00:00:00 2001 From: follower Date: Sun, 27 Sep 2020 04:40:15 +1300 Subject: [PATCH 2/3] Fix line length error. Reduced line length to <100 (as indicated by PR build error). (Also removed extra space character before link.) --- src/contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index ba446b274..b797a6b0a 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -373,9 +373,9 @@ the submodule to. Running `./x.py build` should work now. ## Writing Documentation Documentation improvements are very welcome. The source of `doc.rust-lang.org` -is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated -from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function in the same way -as other pull requests. +is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated +from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function +in the same way as other pull requests. [srcdoc]: https://github.com/rust-lang/rust/tree/master/src/doc [librs]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1 From 158fa22e33a39651936cba1f1a703e787d2e4d4a Mon Sep 17 00:00:00 2001 From: follower Date: Sun, 27 Sep 2020 22:16:59 +1300 Subject: [PATCH 3/3] Use implicit reference links for shorter lines (As suggested by jyn514.) --- src/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index b797a6b0a..5dd80c933 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -373,12 +373,12 @@ the submodule to. Running `./x.py build` should work now. ## Writing Documentation Documentation improvements are very welcome. The source of `doc.rust-lang.org` -is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated -from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function +is located in [`src/doc`] in the tree, and standard API documentation is generated +from the source code itself (e.g. [`lib.rs`]). Documentation pull requests function in the same way as other pull requests. -[srcdoc]: https://github.com/rust-lang/rust/tree/master/src/doc -[librs]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1 +[`src/doc`]: https://github.com/rust-lang/rust/tree/master/src/doc +[`lib.rs`]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1 To find documentation-related issues, sort by the [T-doc label][tdoc].