Skip to content

idiomatic: remove weasel words #3035

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.

Sign up for GitHub

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

Open
mgeisler wants to merge 3 commits into
base: main
Choose a base branch
from
Open

idiomatic: remove weasel words #3035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34a4f7b
idiomatic: remove weasel words
mgeisler Jan 31, 2026
3b8d847
idiomatic: revert non-significant changes
mgeisler Feb 14, 2026
cb73531
idiomatic: updates from review comments
mgeisler Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/idiomatic/foundations-api-design/predictable-api/naming-conventions/from.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,8 @@ impl u32 {
<details>
- Prefix for constructor-style, `From`-trait-style functions.

- These functions can take multiple arguments, but usually imply the user is
doing more of the work than a usual constructor would.

`new` is still preferred for most constructor-style functions, the implication
for `from` is transformation of one data type to another.
- `new` is preferred for constructor-style functions, the implication for `from`
is transformation of one data type to another.

- Ask: Without looking at the standard library documentation, what would the
argument type of `u32::from_be` be?
Expand Down
2 changes: 1 addition & 1 deletion src/idiomatic/foundations-api-design/predictable-api/naming-conventions/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ impl <T> OnceCell {
<details>
- Gets are trivial, they get a value!

Immutable by default, for the most part.
Immutable by default.

Should not panic. May return an option or result, depending on the framework.

Expand Down