Skip to content

Commit 6cd4660

Browse files
authored
Rollup merge of #40803 - lukaramu:contributing-docs, r=steveklabnik
Update CONTRIBUTING.md regarding documentation contributions Changed link to documentation issues from A-docs to T-doc as this has just been migrated. Added a link to the documentation style guidelines in RFC 1574 (I've linked to [Appendix A][1] specifically since that's the combined version). r? @steveklabnik [1]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
2 parents 0566e13 + 7643ccd commit 6cd4660

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Diff for: CONTRIBUTING.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,13 @@ To save @bors some work, and to get small changes through more quickly, when
311311
the other rollup-eligible patches too, and they'll get tested and merged at
312312
the same time.
313313

314-
To find documentation-related issues, sort by the [A-docs label][adocs].
314+
To find documentation-related issues, sort by the [T-doc label][tdoc].
315315

316-
[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs
316+
[tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc
317+
318+
You can find documentation style guidelines in [RFC 1574][rfc1574].
319+
320+
[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
317321

318322
In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly
319323
to check small fixes. For example, `rustdoc src/doc/reference.md` will render

0 commit comments

Comments
 (0)