Skip to content

Conversation

apiraino
Copy link
Contributor

@apiraino apiraino commented Aug 6, 2025

Sister PR of rust-forge#926.

Add clearer wording about our "spellchecking / typos" contributing policy to discourage spellcheck patches on internal documentation.

@rustbot
Copy link
Collaborator

rustbot commented Aug 6, 2025

Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using r? rustc-dev-guide or r? <username>.

@rustbot rustbot added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Aug 6, 2025
@apiraino
Copy link
Contributor Author

apiraino commented Aug 6, 2025

r? rustc-dev-guide

(just to get a +1 and be sure this is fine)

@tshepang
Copy link
Member

tshepang commented Aug 6, 2025

what counts as internal docs

@apiraino
Copy link
Contributor Author

apiraino commented Aug 6, 2025

I linked in the other PR some examples.

@tshepang
Copy link
Member

tshepang commented Aug 6, 2025

a summary seems to be...

anything not user-facing

@tshepang
Copy link
Member

tshepang commented Aug 6, 2025

we could be more explicit and say something like...

Comment fix PRs are not allowed if not accompanied with other improvements to the files they touch.

@tshepang
Copy link
Member

do people consider rustc api docs internal docs

@jieyouxu
Copy link
Member

You mean the rustc_* crate docs? Yes.

@tshepang
Copy link
Member

would be good to be more concrete what we consider internal docs

so far, I have this list

  • code comments
  • rustc api docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants