From 1ac8ae25c88ab4e241d7b6028a34e39a35b77e09 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Fri, 5 Sep 2025 10:21:25 +0200 Subject: [PATCH] clarify typo pr guidance --- src/contributing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 1ade4953d..8b1e05e1c 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -370,8 +370,10 @@ You can also use `rustdoc` directly to check small fixes. For example, `rustdoc src/doc/reference.md` will render reference to `doc/reference.html`. The CSS might be messed up, but you can verify that the HTML is right. -Please notice that at this time we don't accept typography/spellcheck fixes to **internal documentation** (example: -tests, library or compiler code) as it's usually not worth the churn or the review time. +Please notice that we don't accept typography/spellcheck fixes to **internal documentation** +as it's usually not worth the churn or the review time. +Examples of internal documentation is code comments and rustc api docs. +However, feel free to fix those if accompanied by other improvements in the same PR. ### Contributing to rustc-dev-guide