Skip to content

Convert 'may not' to either 'must not' or 'might not' in the standard library documentation #83584

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

Closed
jyn514 opened this issue Mar 27, 2021 · 11 comments
Assignees
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@jyn514
Copy link
Member

jyn514 commented Mar 27, 2021

"may not" has two possible meanings:

  1. A command: "You may not stay up past your bedtime."
  2. A fact that's only sometimes true: "Some cities may not have bike lanes."

In some cases, the meaning is ambiguous: "Some cars may not have snow
tires." (do the cars happen to not have snow tires, or is it
physically impossible for them to have snow tires?)

It would be better to change places where the standard library uses the "description of
fact" meaning to say "might not" instead, and change the "command" meaning to "must not".

You can find places where "may not" is used like so:

fd '.*' library/ | rg -v 'LICENCE|backtrace|stdarch' | xargs rg --glob '!library/backtrace/crates/backtrace-sys/**' 'may not'

Originally posted by @jyn514 in #83582

@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. labels Mar 27, 2021
@jessehorne
Copy link

@rustbot claim

@amalik18
Copy link

@rustbot claim

@rustbot rustbot assigned amalik18 and unassigned jessehorne Jul 21, 2021
@jyn514
Copy link
Member Author

jyn514 commented Jul 21, 2021

@amalik18 FYI a lot of the changes were already done in #83614, you could start from there :)

@amalik18
Copy link

Oh......I completely forgot about that hahahah

@amalik18
Copy link

I'm trying to create a new branch but i'm getting a ERROR: Permission to rust-lang/rust.git denied to amalik18. Any pointers?

@jyn514
Copy link
Member Author

jyn514 commented Jul 23, 2021

@amalik18 are you trying to download using SSH? Use HTTP instead: git set-url origin https://github.com/rust-lang/rust.git.

@amalik18
Copy link

Yep using HTTPS. I even generated a public access token. Still getting the error:

remote: Permission to rust-lang/rust.git denied to amalik18.
fatal: unable to access 'https://github.com/rust-lang/rust.git/': The requested URL returned error: 403

@jyn514
Copy link
Member Author

jyn514 commented Jul 24, 2021

@amalik18 can you join the Zulip so I can help you debug this without spamming the issue tracker? https://rust-lang.zulipchat.com/

@amalik18
Copy link

#87445

@amalik18
Copy link

The PR has been merged. #87445 @jyn514 you can go ahead and close if you'd like.

@jyn514
Copy link
Member Author

jyn514 commented Jul 30, 2021

Thanks for working on this!

@jyn514 jyn514 closed this as completed Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants