Skip to content

FromZeroes is misspelt #431

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

Jump to bottom
Closed
Tracked by #671
jswrenn opened this issue Sep 29, 2023 · 1 comment
Closed
Tracked by #671

FromZeroes is misspelt #431

jswrenn opened this issue Sep 29, 2023 · 1 comment
Labels
blocking-next-release This issue should be resolved before we release on crates.io

Comments

@jswrenn
Copy link
Collaborator

jswrenn commented Sep 29, 2023

We need to rename FromZeroes to FromZeros. We attempted this in #430, by doing the rename, and providing an alias:

/// Deprecated: prefer [`FromZeros`] instead.
#[doc(hidden)]
pub use FromZeros as FromZeroes;

The intention here was that this would gently nudge users towards FromZeros, and then in 0.8, we would add a deprecated notice:

#[deprecated(since = "0.8.0", note = "FromZeroes has been renamed to FromZeros")]

However, we found from our UI tests that Rust recommends using "FromZeroes" in its suggestions — even when it's both doc(hidden) and deprecated. This would have the opposite of the intended effect.

We need to investigate whether this is a fixable Rust bug, and if there is any action we can take before 0.8.
@joshlf joshlf added the blocking-next-release This issue should be resolved before we release on crates.io label Sep 29, 2023
@joshlf joshlf changed the title FromZeroes is misspelt. FromZeroes is misspelt Oct 12, 2023
@joshlf joshlf mentioned this issue Dec 4, 2023
Open
87 tasks
jswrenn added a commit that referenced this issue Dec 7, 2023
@jswrenn
Rename FromZeroes to FromZeros
b9c524b 
Although both spelling are acceptable, "zeros" is the somewhat more
common [1] spelling of the plural noun "zero". We continue to use
the spelling "zeroes" for the verb; i.e., to replace bytes with the
value `0`. For user convenience, `FromZeroes` is retained as a
deprecated, `doc(hidden)` re-export of `FromZeros`.

Closes #431

[1] https://english.stackexchange.com/questions/3824/what-is-the-plural-form-of-zero/3825#3825
jswrenn added a commit that referenced this issue Dec 7, 2023
@jswrenn
Rename FromZeroes to FromZeros
0cee813 
Although both spellings are acceptable, "zeros" is the somewhat more
common [1] spelling of the plural noun "zero". We continue to use
the spelling "zeroes" for the verb; i.e., to replace bytes with the
value `0`. For user convenience, `FromZeroes` is retained as a
deprecated, `doc(hidden)` re-export of `FromZeros`.

Closes #431

[1] https://english.stackexchange.com/questions/3824/what-is-the-plural-form-of-zero/3825#3825
github-merge-queue bot pushed a commit that referenced this issue Dec 7, 2023
@jswrenn
Rename FromZeroes to FromZeros (#430)
62ee07e 
Although both spellings are acceptable, "zeros" is the somewhat more
common [1] spelling of the plural noun "zero". We continue to use
the spelling "zeroes" for the verb; i.e., to replace bytes with the
value `0`. For user convenience, `FromZeroes` is retained as a
deprecated, `doc(hidden)` re-export of `FromZeros`.

Closes #431

[1] https://english.stackexchange.com/questions/3824/what-is-the-plural-form-of-zero/3825#3825
@joshlf
Copy link
Member

joshlf commented Dec 8, 2023

Closed in #430.

@joshlf joshlf closed this as completed Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocking-next-release This issue should be resolved before we release on crates.io
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joshlf @jswrenn