Document canonical value presentation #5919
Open
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.
What's Changing
This is my attempt to document how the tools present values in a canonical form in the human-readable output formats such as SUP.
Why
When fielding community inquiry #5910 and writing up a response, I recognized that this topic might benefit from a little more coverage.
Details
I expect that some aspects of canonical value presentation shown here would be unsurprising to most users, e.g., dropping trailing zeros in floating point values. OTOH, things like the
durationtype may be slightly less familiar to users, leading to confusion such as expressed in #5910. While docs enhancements like I'm doing here may not guarantee future users would never be confused by such things again, I figure it doesn't hurt to cover it somewhere, plus it gives me something in the docs to point at if similar questions from users come up in the future.