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.

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

Make infallible alignment errors more discoverable #1721

Closed
Tracked by #671
joshlf opened this issue Sep 21, 2024 · 0 comments · Fixed by #1737
Closed
Tracked by #671

Make infallible alignment errors more discoverable #1721

joshlf opened this issue Sep 21, 2024 · 0 comments · Fixed by #1737
Labels
blocking-next-release-publicization

Comments

@joshlf
Copy link
Member

joshlf commented Sep 21, 2024

Following up on #1718, do the following:

  • In the error module docs, reference infallible alignment errors
  • In the doc comment for every method that returns an alignment error (or composite error that might be an alignment error), reference infallible alignment errors
This was referenced Sep 21, 2024
Open
Merged
joshlf added a commit that referenced this issue Sep 23, 2024
@joshlf
[docs] Make infallible align errors discoverable
13104d1 
Wherever alignment errors are possible, mention that it is possible to
discard alignment errors when `Dst: Unaligned`.

Closes #1721
@joshlf joshlf mentioned this issue Sep 23, 2024
Merged
joshlf added a commit that referenced this issue Sep 23, 2024
@joshlf
[docs] Make infallible align errors discoverable
304dd43 
Wherever alignment errors are possible, mention that it is possible to
discard alignment errors when `Dst: Unaligned`.

Closes #1721
joshlf added a commit that referenced this issue Sep 23, 2024
@joshlf
[docs] Make infallible align errors discoverable
18c3791 
Wherever alignment errors are possible, mention that it is possible to
discard alignment errors when `Dst: Unaligned`.

Closes #1721
joshlf added a commit that referenced this issue Sep 23, 2024
@joshlf
[docs] Make infallible align errors discoverable
9391fa1 
Wherever alignment errors are possible, mention that it is possible to
discard alignment errors when `Dst: Unaligned`.

Closes #1721
github-merge-queue bot pushed a commit that referenced this issue Sep 23, 2024
@joshlf
[docs] Make infallible align errors discoverable (#1737)
fcc037a 
Wherever alignment errors are possible, mention that it is possible to
discard alignment errors when `Dst: Unaligned`.

Closes #1721
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-publicization
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Make infallible align errors discoverable google/zerocopy
1 participant
@joshlf