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

Renamed as_bytes_mut to as_mut_bytes #870

Merged
merged 1 commit into from
Feb 13, 2024

Conversation

dorryspears
Copy link
Contributor

Closes #253

I saw this in the nice-to-haves in #671, so I thought I would knock it out.

Copy link
Collaborator

@jswrenn jswrenn left a comment

Choose a reason for hiding this comment

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

Can you just edit your commit message to:

Renamed `as_bytes_mut` to `as_mut_bytes`

@dorryspears
Copy link
Contributor Author

@jswrenn Renamed commit

@jswrenn
Copy link
Collaborator

jswrenn commented Feb 13, 2024

Whoops, sorry for the inconvenience, but I didn't mean for you to edit out the reference to the issue. The full message should be something like this:

Renamed `as_bytes_mut` to `as_mut_bytes`

Fixes #253

@joshlf
Copy link
Member

joshlf commented Feb 13, 2024

Whoops, sorry for the inconvenience, but I didn't mean for you to edit out the reference to the issue. The full message should be something like this:

Renamed `as_bytes_mut` to `as_mut_bytes`

Fixes #253

...and if you want to be really pedantic with our commit message guidelines, it should be "Rename as_bytes_mut..." rather than "Renamed as_bytes_mut..." (past tense). To be clear, we will absolutely still merge this without that tiny change, but while we're nitpicking 😛

@dorryspears
Copy link
Contributor Author

@jswrenn @joshlf I appreciate the guidance, I am new to zerocopy, learning the ways 🎉
Changed commit message to include the issue and reflect the grammar from the guidelines

@jswrenn
Copy link
Collaborator

jswrenn commented Feb 13, 2024

One last tweak: Just put a double newline between the subject and 'Fixes', like this:

Renamed `as_bytes_mut` to `as_mut_bytes`

Fixes #253

Right now, they're all on one line.

@jswrenn
Copy link
Collaborator

jswrenn commented Feb 13, 2024

We do this because git treats the first line of the commit message as its subject; see here: https://github.com/google/zerocopy/commit/bff9148ad8e7bf034e0992a1f8b4bf9553f2e386.patch

@dorryspears
Copy link
Contributor Author

@jswrenn fixed commit message

@joshlf joshlf added this pull request to the merge queue Feb 13, 2024
@joshlf
Copy link
Member

joshlf commented Feb 13, 2024

Thanks for this, @dorryspears !

Merged via the queue into google:main with commit 82f03fc Feb 13, 2024
209 checks passed
dorryspears added a commit to dorryspears/zerocopy that referenced this pull request Feb 20, 2024
joshlf added a commit that referenced this pull request Mar 1, 2024
This was renamed to `as_mut_bytes` in #870. This commit adds the old
name back as a `#[doc(hidden)]`, `#[deprecated]` alias to ease the
transition.

Closes #986
joshlf added a commit that referenced this pull request Mar 1, 2024
This was renamed to `as_mut_bytes` in #870. This commit adds the old
name back as a `#[doc(hidden)]`, `#[deprecated]` alias to ease the
transition.

Closes #986
github-merge-queue bot pushed a commit that referenced this pull request Mar 1, 2024
This was renamed to `as_mut_bytes` in #870. This commit adds the old
name back as a `#[doc(hidden)]`, `#[deprecated]` alias to ease the
transition.

Closes #986
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.

Consider renaming as_bytes_mut to as_mut_bytes
3 participants