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 TryFromBytes methods to be consistent with FromBytes #1119

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

jswrenn
Copy link
Collaborator

@jswrenn jswrenn commented Apr 18, 2024

For example, try_from_ref is now try_ref_from.

See: #1095

@jswrenn jswrenn marked this pull request as ready for review April 18, 2024 17:32
@jswrenn jswrenn requested a review from joshlf April 18, 2024 17:33
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.

Can you add to the commit message:

Makes progress on #5

src/lib.rs Outdated
/// [*valid instance*]: #what-is-a-valid-instance
#[cfg_attr(feature = "derive", doc = "[derive]: zerocopy_derive::TryFromBytes")]
#[cfg_attr(
not(feature = "derive"),
doc = concat!("[derive]: https://docs.rs/zerocopy/", env!("CARGO_PKG_VERSION"), "/zerocopy/derive.TryFromBytes.html"),
)]
// TODO(#5): Update `try_from_ref` doc link once it exists
// TODO(#5): Update `try_ref_from` doc link once it exists
Copy link
Member

Choose a reason for hiding this comment

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

Is this TODO done? Can we remove it while we're here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done!

@joshlf
Copy link
Member

joshlf commented Apr 18, 2024

Can you add to the commit message:

Makes progress on #5

Still need to do this ^

For example, `try_from_ref` is now `try_ref_from`.

See: #1095

Makes progress on #5
@jswrenn
Copy link
Collaborator Author

jswrenn commented Apr 18, 2024

Whoops, missed that. Done.

@jswrenn jswrenn enabled auto-merge April 18, 2024 18:23
@jswrenn jswrenn added this pull request to the merge queue Apr 18, 2024
Merged via the queue into main with commit af66ecd Apr 18, 2024
210 checks passed
@jswrenn jswrenn deleted the tfb-method-consistency branch April 18, 2024 18:38
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