Skip to content

Comments

idiomatic: remove weasel words#3035

Open
mgeisler wants to merge 2 commits intomainfrom
weasel-idiomatic
Open

idiomatic: remove weasel words#3035
mgeisler wants to merge 2 commits intomainfrom
weasel-idiomatic

Conversation

@mgeisler
Copy link
Collaborator

This PR removes imprecise language ('weasel words') to align with the new precision guidelines in #3029.


Note: This PR was generated using Gemini. Please review the changes accordingly. If the new style is not desired for this section, feel free to close this PR.

@mgeisler mgeisler enabled auto-merge (squash) January 31, 2026 11:19
Copy link
Collaborator

@gribozavr gribozavr left a comment

Choose a reason for hiding this comment

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

@mgeisler I think there are some good changes here, but most of this PR is making replacements that are not a clear improvement. Could you do a manual pass over it?

@mgeisler
Copy link
Collaborator Author

@mgeisler I think there are some good changes here, but most of this PR is making replacements that are not a clear improvement. Could you do a manual pass over it?

Certainly! The changes are now restricted to ones that related to technical concepts instead of more general language fixes.

Comment on lines -33 to +35
- "to" methods most commonly take `&self`. However they can take `self` by value
if the type implements `Copy`: this also ensures that the conversion method
call does not consume `self`.
- "to" methods take `&self`. However they can take `self` by value if the type
implements `Copy`: this also ensures that the conversion method call does not
consume `self`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please undo this one.

Comment on lines -30 to +32
- `into_inner` is a method usually found on newtypes: types whose main purpose
is to wrap around an existing type and be semantically distinct from other
uses of that inner type.
- `into_inner` is a method found on newtypes: types whose main purpose is to
wrap around an existing type and be semantically distinct from other uses of
that inner type.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd say undo this one. It means that it is common, but not mandatory for newtypes to provide this method.

Comment on lines -34 to +35
- These functions can take multiple arguments, but usually imply the user is
doing more of the work than a usual constructor would.
- These functions can take multiple arguments, but imply the user is expected to
provide the data that the type is composed of.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a better rewrite that you can think of? I think there must be more smooth ways to say this.

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.

2 participants