docs: Adds note about serialization error case #5617
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Goal
Fully document all of the serialization feature's error cases.
Why
Someone was receiving this error and didn't know how to interpret it. I like to add documentation when people ask questions.
How
Adds another note to our s2n_serialize API header.
Callouts
Technically I could put this in the usage guide, the serialization header is getting a little large. But I decided not to since it's like two sentences.
Testing
N/A
Related
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.