Clarify rules for packing and unpacking in Section 8.1 #456
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
|
I think this change is a great improvement to the documentation. Thank you. |
kmuehlbauer
reviewed
Sep 18, 2023
There was a problem hiding this comment.
Thanks @JonathanGregory. I agree with @mankoff, this is a great improvement.
ch08.adoc
Outdated
| An additional restriction in this case is that the variable containing the packed data must be of type **`byte`**, **`short`** or **`int`**. | ||
| It is not advised to unpack an **`int`** into a **`float`** as there is a potential precision loss. | ||
|
|
||
| When packed data is written, the **`scale_factor`** and **`add_offset`** attributes must be of the same type as the unpacked data, which must be either **`float`** or **`double`**. Data of type **`float`** must be packed into one of these types: **`byte`**, **`unsigned byte`**, **`short`**, **`unsigned short`**. Data of type **`double`** must be backed into one of these types: **`byte`**, **`unsigned byte`**, **`short`**, **`unsigned short`**, **`int`**, **`unsigned int`**. |
There was a problem hiding this comment.
Whoops. Now fixed. Thanks.
This was referenced Sep 18, 2023
4 tasks
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.
See issue #374 for discussion of these changes.
Release checklist
cf-conventions.adoc?cf-conventions.adocup to date? Versioning inspired by SemVer.history.adocup to date?