Skip to content

Commit d03ffd4

Browse files
authored
Merge pull request #2573 from rust-lang/tshepang/make-more-clear
clarify typo pr guidance
2 parents 1ac6be7 + 1ac8ae2 commit d03ffd4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/contributing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,8 +374,10 @@ You can also use `rustdoc` directly to check small fixes. For example,
374374
`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.
375375
The CSS might be messed up, but you can verify that the HTML is right.
376376

377-
Please notice that at this time we don't accept typography/spellcheck fixes to **internal documentation** (example:
378-
tests, library or compiler code) as it's usually not worth the churn or the review time.
377+
Please notice that we don't accept typography/spellcheck fixes to **internal documentation**
378+
as it's usually not worth the churn or the review time.
379+
Examples of internal documentation is code comments and rustc api docs.
380+
However, feel free to fix those if accompanied by other improvements in the same PR.
379381

380382
### Contributing to rustc-dev-guide
381383

0 commit comments

Comments
 (0)