Explicitly document that pod_read_unaligned and try_pod_read_unaligned don't panic on unaligned reads #220
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d don't panic on unallowed reads Their names make that reasonably clear already, but it doesn't hurt to be explicit. Also, when choosing between `*from_bytes(x)` and `pod_read_unaligned(x)`, it's good to have a clearly documented criterion.
Add a couple of missing links, add a missing "like" (consistent with other similar sentences).
The redundant link emits a warning in `cargo doc`.
Lokathor
approved these changes
Jan 25, 2024
|
released in |
hniksic
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Their names make that reasonably clear already, but it doesn't hurt to be explicit. Also, when choosing between
*from_bytes(x)andpod_read_unaligned(x), it's good to have a clearly documented criterion.The PR also adds a couple other cosmetic doc fixes, as separate commits.