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

Fix grammar in 1.81.0 release #1400

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

Conversation

schuelermine
Copy link

This sentence is on the whole a bit weird as it’s not clear what the subject of "warn if it doesn't" is, but I think this conjugation makes more sense overall

@schuelermine
Copy link
Author

I’ve just been informed that the sentence might’ve been intended to read as "allows explicitly noting, and allows explicitly warning". I feel that way of phrasing it is still worse than this one.

@schuelermine
Copy link
Author

An alternate, more explicit, less ambiguous and weird way to phrase this would be

[…] which allows explicitly noting that a particular lint should occur, and causes the compiler to emit a warning if it doesn’t.

@@ -45,7 +45,7 @@ requirements documented in [PartialOrd] and [Ord].
### `#[expect(lint)]`

1.81 stabilizes a new lint level, `expect`, which allows explicitly noting that
a particular lint *should* occur, and warning if it doesn't. The intended use
a particular lint *should* occur, and warn if it doesn't. The intended use
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're going to not use the gerund here then it needs to agree with the singular "lint level".

Suggested change
a particular lint *should* occur, and warn if it doesn't. The intended use
a particular lint *should* occur, and warns if it doesn't. The intended use

i.e. "lint level, expect, which [...] warns if it doesn't"

Though I don't agree that this needs changing at all. Or at least this should be split into two separate sentences if it's ambiguous.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "warn" is not marked because there's an auxiliary, "should".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this way of phrasing it is weird, we’re saying this “allows explicitly noting that a particular lint […] warns if it [doesn’t occur]”

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants