Add documentation about raw vs normal values for parsed parameters #106
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
medley56
force-pushed
the
87-add-documentation-regarding-raw_packet_data-raw_value-and-value
branch
from
ba02b71 to
445bc50
Compare
medley56
added this to the Version 5.1.0 - Xarray output conversion layer and CLI milestone
greglucas
approved these changes
Oct 10, 2024
There was a problem hiding this comment.
The code all looks good to me. A minor suggestion on docs.
As a side note, I would be amazed if someone in flight software wanted an enumerated float lookup, that seems very fragile... I can just imagine some floating point errors creeping into an exact lookup like that!
|
I totally agree about the float encoded enum. It's an absolutely terrible idea because of the imprecise storage of float values but XTCE allows it so I want to support it but document that it's a terrible idea 😆 |
Add example documentation for each parameter type Add support for float and string encoded enumerated lookups
medley56
force-pushed
the
87-add-documentation-regarding-raw_packet_data-raw_value-and-value
branch
from
445bc50 to
2d775fb
Compare
medley56
deleted the
87-add-documentation-regarding-raw_packet_data-raw_value-and-value
branch
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.
Add support for float and string encoded enumerated lookups
Checklist