-
Notifications
You must be signed in to change notification settings - Fork 64
Rsdk 2634 fix movement sensor property link #263
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
Merged
purplenicole730
merged 18 commits into
viamrobotics:main
from
purplenicole730:RSDK-2634-fix-movement-property-sensor-link
Apr 25, 2023
Merged
Rsdk 2634 fix movement sensor property link #263
purplenicole730
merged 18 commits into
viamrobotics:main
from
purplenicole730:RSDK-2634-fix-movement-property-sensor-link
Apr 25, 2023
Conversation
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
Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!
|
stuqdog
approved these changes
Apr 21, 2023
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.
I think I lack a bit of context here but LGTM modulo a question and a nit.
njooma
requested changes
Apr 21, 2023
njooma
approved these changes
Apr 25, 2023
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.
RSDK-2634
Originally the ticket was only supposed to fix the movement sensor property link in the docs, but it was expanded to include fixing the docs for other return types and parameters as well.
For example, the links for
Pose
would not point to the same link in the description and header of many functions. Now both links are pointing to the same link.In addition, for clarity and better direction, it was decided for the init files of each resource to import from the proto instead of the client/server/resource class. This way, the type links generated in the docs stay in the resource section (if appropriate).