Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README for changes in cbor v2.5.0 #427

Merged
merged 3 commits into from
Sep 4, 2023
Merged

Update README for changes in cbor v2.5.0 #427

merged 3 commits into from
Sep 4, 2023

Conversation

fxamacker
Copy link
Owner

@fxamacker fxamacker commented Sep 3, 2023 •
edited
Loading

Changes:

  • Add example decoding 181 bytes with encoding/gob and getting fatal "out of memory" error.
  • Add example encoding 3-level nested Go struct with fxamacker/cbor to just 1 byte CBOR.
  • Status: mention extended beta period v2.5.0-beta (Dec 2022) -> v2.5.0 (Aug 2023)
  • Reorder intro section.
  • Quick Start: add "NOTE: Unmarshal returns ExtraneousDataError if there are remaining bytes, but new funcs UnmarshalFirst and DiagnoseFirst do not."
  • Versions and API Changes: mention extended beta period for non-API changes to behavior of existing functions.
  • Versions and API Changes: add "This project avoids breaking changes to behavior of encoding and decoding functions unless required to improve conformance with supported RFCs (e.g. RFC 8949, RFC 8742, etc.) Visible changes that don't improve conformance to standards are typically made available as new opt-in settings or new functions."

@fxamacker
Update README for changes in cbor v2.5.0
6455f75 
Add example decoding 181 bytes with encoding/gob and getting fatal "out of memory" error.

Add example encoding 3-level nested Go struct with fxamacker/cbor to 1 byte CBOR.

Reorder intro section.

Update and clarify "Versions and API Changes" section.

Update "Status" section to mention extended 2.5.0-beta period.

Add to Quick Start:  "NOTE: Unmarshal returns ExtraneousDataError if there are remaining bytes, but new funcs UnmarshalFirst and DiagnoseFirst do not."
@fxamacker fxamacker added the docs label Sep 3, 2023
@fxamacker fxamacker self-assigned this Sep 3, 2023
x448
x448 approved these changes Sep 3, 2023
View reviewed changes
Copy link
Contributor

@x448 x448 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM.

Below the example program encoding 3-level nested struct to 18-byte JSON vs 1-byte CBOR, include its output.

In the README:

  • Standards section is outdated. Forgot to mention of CBOR Sequences (RFC 8742), etc.
  • A project logo would be nice to add.

@fxamacker fxamacker requested a review from x448 September 4, 2023 03:18
x448
x448 approved these changes Sep 4, 2023
View reviewed changes
Copy link
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.

LGTM!

Just one thing: add a sentence above the Struct Tag example to separate it from prior example. Like what you did in quick start.

@fxamacker fxamacker requested a review from x448 September 4, 2023 03:39
@fxamacker fxamacker merged commit f8bac85 into master Sep 4, 2023
13 checks passed
@fxamacker fxamacker deleted the fxamacker/update-README branch December 28, 2023 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@x448 x448 x448 approved these changes

Assignees

@fxamacker fxamacker

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fxamacker @x448