Skip to content
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-2221: Add descriptions to methods #4003

Conversation

skyleilani
Copy link
Contributor

@skyleilani skyleilani commented May 24, 2024

Added method descriptions to any resource methods that did not have descriptions in the interface.

The motion service is not included in this PR. It is being addressed in a separate PR where the samples are being reviewed for functionality as well.

@viambot viambot added the safe to test This pull request is marked safe to test from a trusted zone label May 24, 2024
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 IsMoving
board GPIOPinByName
camera Properties
encoder Properties
motor IsMoving
sensor Readings
servo Position
arm EndPosition
audio MediaProperties
gantry Lengths
gripper IsMoving
input_controller Controls
movement_sensor LinearAcceleration
power_sensor Power
pose_tracker Poses
motion GetPose
vision GetProperties

@skyleilani skyleilani requested a review from andf-viam May 24, 2024 18:43
@skyleilani
Copy link
Contributor Author

Addressed in PR thanks to @andf-viam

@skyleilani skyleilani closed this Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants