Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make examples coherent with text #3787

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vigna
Copy link

@vigna vigna commented Mar 7, 2025

The example in the API conventions (in imperative) contradicts the text (use third person). This PR corrects the example to fit the text description.

Rendered

@vigna vigna changed the title Made example coherent with text Make examples coherent with text Mar 7, 2025
@ehuss ehuss added the T-libs-api Relevant to the library API team, which will review and decide on the RFC. label Mar 7, 2025
@Noratrieb Noratrieb added the not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc. label Mar 8, 2025
@scottmcm
Copy link
Member

We generally leave old RFCs alone (https://github.com/rust-lang/rfcs?tab=readme-ov-file#the-rfc-life-cycle), not changing the text in them, other than maybe adding a process note at the top (like 6006f43).

I'm inclined to close this as non-a-bug.

@vigna
Copy link
Author

vigna commented Mar 10, 2025

Yep, probably nobody reads or follows those description except me—they can stay contradictory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc. T-libs-api Relevant to the library API team, which will review and decide on the RFC.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants