Defining XML element: State units that should be used#216
Open
hamishwillee wants to merge 1 commit intomasterfrom
Open
Defining XML element: State units that should be used#216hamishwillee wants to merge 1 commit intomasterfrom
hamishwillee wants to merge 1 commit intomasterfrom
Conversation
hamishwillee
commented
Oct 9, 2019
| - The description should not include units information. | ||
| - `units`: optional, for indicating units | ||
| - SI units should be used where possible (units are constrained by the XML DTD) | ||
| > **Note** Use natural units like radians or quaternions where possible as these allow greater precision and fewer issues for implementers than units like degrees. |
Collaborator
Author
There was a problem hiding this comment.
@LorenzMeier I couldn't find a good place to capture the discussion about not just automatically using human readable units. This note is at least something that makes sure the point is made
hamishwillee
commented
Oct 9, 2019
| Each field should only have **one** or no units. | ||
| - *should* use the `enum` attribute where possible results are finite/well understood. | ||
| - `name`: required | ||
| - must be unique within a message. |
Collaborator
Author
There was a problem hiding this comment.
Do we have any other requirements on names? Ie do we prefer them to be snake cased (underscores). Do we prefer full names or do we allow truncation - eg. bat_status, vs battery_status etc?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 change provides a little more information about how XML elements should be defined.