Skip to content

Update docs for cbor v2.8.0#649

Merged
fxamacker merged 5 commits intomasterfrom
fxamacker/update-docs-for-v2.8.0
Mar 30, 2025
Merged

Update docs for cbor v2.8.0#649
fxamacker merged 5 commits intomasterfrom
fxamacker/update-docs-for-v2.8.0

Conversation

@fxamacker
Copy link
Copy Markdown
Owner

@fxamacker fxamacker commented Mar 30, 2025

Update README.md:

  • Update "Status" section.

  • Replace "struct tags" with "struct tag options" when referring to options.

Update doc.go:

  • Mention omitzero option (for struct tags) in more places. Also mention Diagnose, DiagnoseFirst, UnmarshalFirst, etc. added in prior releases.

  • Add example using UnmarshalFirst to show support for trailing bytes (extraneous data) typically found in CBOR Sequences (RFC 8742).

  • Add example using DiagnoseFirst to 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

  • Replace "struct tags" with "struct tag options" when referring to options.

@fxamacker fxamacker added the docs label Mar 30, 2025
@fxamacker fxamacker added this to the v2.8.0 milestone Mar 30, 2025
@fxamacker fxamacker self-assigned this Mar 30, 2025
@fxamacker fxamacker changed the title Update docs for cbor v2.8.0 WIP: Update docs for cbor v2.8.0 Mar 30, 2025
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.
@fxamacker fxamacker changed the title WIP: Update docs for cbor v2.8.0 Update docs for cbor v2.8.0 Mar 30, 2025
@fxamacker
Copy link
Copy Markdown
Owner Author

PTAL @x448

Copy link
Copy Markdown
Contributor

@x448 x448 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: add omitzero to example_test.go.

@fxamacker fxamacker merged commit cbe7442 into master Mar 30, 2025
22 checks passed
@fxamacker fxamacker deleted the fxamacker/update-docs-for-v2.8.0 branch April 1, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants