-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: variable documentation #134
Open
ihagad
wants to merge
7
commits into
main
Choose a base branch
from
92-docs-data-collection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
dcc9f0e
docs: variable documentation
ihagad db88da8
docs: data collection variable doc updates
ihagad 1094d57
Merge branch 'main' into 92-docs-data-collection
ihagad b2b99ab
Merge branch '92-docs-data-collection' of https://github.com/UCSD-E4E…
ihagad 6e842b0
docs: variable doc changes
ihagad 401d778
docs: fix variable docs
ihagad 08475cb
docs: variable documentation fixes
ihagad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this mean that if
acc
has the value{1, 0, 0}
, I should interpret this as [0.000059, 0, 0] g's of acceleration?Conversely, should I expect [1, 0, 0] g's of acceleration to be represented at
{16834, 0, 0}
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when you specify this, please add units for the real-world value so that it is unambiguously the real-world value vs the stored representation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This ends up being confusing - are we stating that the values as stored in memory are directly interpretable as G's of acceleration?
Additionally, in line 26, I think you have the wrong constant.
One suggested wording might be this:
Consider updating the other field documentation to be similar.