diff options
| author | Tshepang Mbambo <hopsi@tuta.io> | 2025-09-08 06:26:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-08 06:26:12 +0200 |
| commit | 30ad58fc1df8d369602e64a64f20ea8107461eb7 (patch) | |
| tree | 116ebfe62625be3095045b7e565e5cd04e99133f /src/doc/rustc-dev-guide | |
| parent | 177583d2c04005c94798399f5ddeeed21c79f768 (diff) | |
| parent | f374dce1d9dad014a79637af20ce551da79fd60d (diff) | |
Merge pull request #2573 from rust-lang/tshepang/make-more-clear
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 347608d305a..3d196ae2308 100644 --- a/src/doc/rustc-dev-guide/src/contributing.md +++ b/src/doc/rustc-dev-guide/src/contributing.md @@ -374,8 +374,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 |
