Improve docs on ZeroVecError #5117
Merged
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
utils/zerovec/src/error.rs
Outdated
| ParseError { ty: &'static str }, | ||
| /// The byte buffer was not in the appropriate format for VarZeroVec | ||
| /// The byte buffer was not in the appropriate format for VarZeroVec. | ||
| /// This error comes from `zerovec` as opposed to a ULE impl. |
There was a problem hiding this comment.
I think if you have a ZeroVecError you should point out when an error does not come from zerovec. Also, by zerovec, do you mean the crate? Or do you mean (Var)?Zero(Vec|Slice)?
Can this error be split up?
There was a problem hiding this comment.
Is this better?
This is probably a good candidate for a Narrow Error Types treatment, but I'm just currently trying to improve the docs since #5002 didn't use the correct error variant
Manishearth
approved these changes
Jun 25, 2024
younies
approved these changes
Jun 25, 2024
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.
#5002