Skip to content

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

Closed
@jyn514

Description

@jyn514
Member

"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

Activity

added
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
E-help-wantedCall for participation: Help is requested to fix this issue.
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
on Mar 27, 2021
jessehorne

jessehorne commented on Mar 28, 2021

@jessehorne

@rustbot claim

amalik18

amalik18 commented on Jul 21, 2021

@amalik18

@rustbot claim

jyn514

jyn514 commented on Jul 21, 2021

@jyn514
MemberAuthor

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

amalik18

amalik18 commented on Jul 21, 2021

@amalik18

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

amalik18

amalik18 commented on Jul 23, 2021

@amalik18

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

jyn514 commented on Jul 23, 2021

@jyn514
MemberAuthor

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

amalik18

amalik18 commented on Jul 24, 2021

@amalik18

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

jyn514 commented on Jul 24, 2021

@jyn514
MemberAuthor

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

amalik18

amalik18 commented on Jul 27, 2021

@amalik18
amalik18

amalik18 commented on Jul 30, 2021

@amalik18

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

jyn514

jyn514 commented on Jul 30, 2021

@jyn514
MemberAuthor

Thanks for working on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @jessehorne@jyn514@amalik18

    Issue actions

      Convert 'may not' to either 'must not' or 'might not' in the standard library documentation · Issue #83584 · rust-lang/rust