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

Rename FromZeroes to FromZeros #430

Merged
merged 1 commit into from
Dec 7, 2023
Merged

Rename FromZeroes to FromZeros #430

merged 1 commit into from
Dec 7, 2023

Conversation

jswrenn
Copy link
Collaborator

@jswrenn jswrenn commented Sep 29, 2023

Pretend you didn't see this.

FromZeroes is retained as a deprecated, doc(hidden) re-export.

Additionally, for consistency, LayoutVerified is changed from a type alias to pub use ... as ... reexport.

@jswrenn jswrenn requested a review from joshlf September 29, 2023 18:14
src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
Copy link
Member

@joshlf joshlf left a comment

Choose a reason for hiding this comment

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

There are some files with the zeroes spelling in the name that need to be changed, but otherwise LGTM!

Copy link
Member

@joshlf joshlf left a comment

Choose a reason for hiding this comment

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

Also, can you update the commit message?

  • Capitalize "rename" in the summary line
  • Mention that "zeroes" is a valid spelling, but that "zeros" is more commonly accepted, possibly citing this StackExchange answer
  • Add Closes #431 at the end

@jswrenn jswrenn force-pushed the from-zeros branch 2 times, most recently from c3263b0 to b9c524b Compare December 7, 2023 18:42
@jswrenn jswrenn requested a review from joshlf December 7, 2023 18:42
Copy link
Member

@joshlf joshlf left a comment

Choose a reason for hiding this comment

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

In the commit message:

Although both spelling are acceptable

Should be "spellings" plural.

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 joshlf changed the title rename FromZeroes to FromZeros Rename FromZeroes to FromZeros Dec 7, 2023
@jswrenn jswrenn added this pull request to the merge queue Dec 7, 2023
Merged via the queue into main with commit 62ee07e Dec 7, 2023
126 checks passed
@jswrenn jswrenn deleted the from-zeros branch December 7, 2023 19:00
/// Deprecated: prefer [`FromZeros`] instead.
#[deprecated(since = "0.8.0", note = "`FromZeroes` was renamed to `FromZeros`")]
#[doc(hidden)]
pub use FromZeros as FromZeroes;
Copy link
Collaborator Author

@jswrenn jswrenn Dec 7, 2023

Choose a reason for hiding this comment

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

This is going to use-rename both the trait and the proc macro (if it's in scope from the derive feature).

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.

None yet

2 participants