Skip to content

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

Closed
@jyn514

Description

@jyn514

"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

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

No branches or pull requests

Issue actions