Rename ByteSliceMode to ByteSliceLaterFormatMode, etc #554
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
Also renamed related options to be consistent.
fxamacker
changed the base branch from
fxamacker/add-userbufferencmode-interface
to
master
x448
approved these changes
Jun 10, 2024
Comment on lines
+811
to
+812
| byteSliceLaterFormat ByteSliceLaterFormatMode | ||
| byteSliceLaterEncodingTag uint64 |
There was a problem hiding this comment.
For consistency, should byteSliceLaterEncodingTag be renamed to byteSliceLaterFormatTag?
There was a problem hiding this comment.
Encoding tag makes more sense to me because it is about CBOR tag number to be encoding.
Comment on lines
-406
to
+411
| // ByteSliceMode specifies how to encode slices of bytes. | ||
| type ByteSliceMode int | ||
| // ByteSliceLaterFormatMode specifies which later format conversion hint (CBOR tag 21-23) | ||
| // to include (if any) when encoding Go byte slice to CBOR byte string. The encoder will | ||
| // always encode unmodified bytes from the byte slice and just wrap it within | ||
| // CBOR tag 21, 22, or 23 if specified. | ||
| // See "Expected Later Encoding for CBOR-to-JSON Converters" in RFC 8949 Section 3.4.5.2. | ||
| type ByteSliceLaterFormatMode int |
There was a problem hiding this comment.
This helped. Thanks for adding more comments.
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.
This PR renamed
ByteSliceModetoByteSliceLaterFormatModeand also renamed related options.For context:
Also considered using
ByteSliceLaterEncodingModebut the word "format" (i.e. encoding format) is probably less ambiguous for people unfamiliar with RFC 8949 Section 3.4.5.2.