diff options
| author | Tshepang Mbambo <hopsi@tuta.io> | 2025-09-05 10:21:25 +0200 |
|---|---|---|
| committer | Tshepang Mbambo <hopsi@tuta.io> | 2025-09-05 10:21:25 +0200 |
| commit | f374dce1d9dad014a79637af20ce551da79fd60d (patch) | |
| tree | 0dfa0adaaba35ce742bd620764998cab9f405a39 /src/doc/rustc-dev-guide | |
| parent | aba7507609a9fbee5efbfa19fc9d1268c8c5534d (diff) | |
clarify typo pr guidance
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/contributing.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/contributing.md b/src/doc/rustc-dev-guide/src/contributing.md index 1ade4953d2e..8b1e05e1cf4 100644 --- a/src/doc/rustc-dev-guide/src/contributing.md +++ b/src/doc/rustc-dev-guide/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 |
