Update docs for cbor v2.8.0 #649
Merged
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
Updated "Status" section for v2.8.0 and v2.7.1. Replaced "struct tags" with "struct tag options" when referring to options. Mention all 3 functions fixed by this release were intended for internal use and is now deprecated. To preserve backward compatibility, these deprecated functions are added to fuzz tests and won't be removed in v2: - ByteString.UnmarshalCBOR() - RawTag.UnmarshalCBOR() - SimpleValue.UnmarshalCBOR()
Replace "struct tag" with "struct tag option" when referring to options.
|
PTAL @x448 |
x448
approved these changes
Mar 30, 2025
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.
Update README.md:
Update "Status" section.
Replace "struct tags" with "struct tag options" when referring to options.
Update doc.go:
Mention
omitzerooption (for struct tags) in more places. Also mentionDiagnose,DiagnoseFirst,UnmarshalFirst, etc. added in prior releases.Add example using
UnmarshalFirstto show support for trailing bytes (extraneous data) typically found in CBOR Sequences (RFC 8742).Add example using
DiagnoseFirstto show support for representing binary CBOR data item in Extended Diagnostic Notation (human-readable text inspired by JSON).Replace "struct tags" with "struct tag options" when referring to options.
Update example_test.go