Skip to content

Conversation

purplenicole730
Copy link
Member

@purplenicole730 purplenicole730 commented Apr 20, 2023

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.

image

image

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).

@purplenicole730 purplenicole730 requested a review from a team as a code owner April 20, 2023 19:52
@github-actions
Copy link
Contributor

Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!

component function
base is_moving
board gpio_pin_by_name
camera get_image
encoder get_position
motor is_moving
sensor get_readings
servo get_position
arm get_end_position
gantry get_lengths
gripper is_moving
movement_sensor get_linear_acceleration
input_controller get_controls
audio get_properties
pose_tracker get_poses
motion get_pose
vision get_detector_names

@purplenicole730 purplenicole730 changed the title Rsdk 2634 fix movement property sensor link Rsdk 2634 fix movement sensor property link Apr 20, 2023
Copy link
Member

@stuqdog stuqdog left a 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.

@cheukt cheukt requested review from njooma and removed request for cheukt April 21, 2023 13:38
@purplenicole730 purplenicole730 requested a review from njooma April 21, 2023 22:19
@purplenicole730 purplenicole730 merged commit fba3893 into viamrobotics:main Apr 25, 2023
@purplenicole730 purplenicole730 deleted the RSDK-2634-fix-movement-property-sensor-link branch April 25, 2023 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants