-
Notifications
You must be signed in to change notification settings - Fork 52
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-2313: Clean up gantry, camera, board, encoder and arm pages for docs parsing #631
DOCS-2313: Clean up gantry, camera, board, encoder and arm pages for docs parsing #631
Conversation
Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!
|
Great start! Thanks @sguequierre !
|
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.
Nice, thanks for doing this! A couple small things, but otherwise this looks great.
src/viam/components/arm/arm.py
Outdated
extra (Optional[Dict[str, Any]]): Extra options to pass to the underlying RPC call. | ||
timeout (Optional[float]): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call. |
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.
The idiom in python is to not provide docstring comments for extra
and timeout
, so we should remove these (and the same comments in below methods). It looks like the same comment is used here as in motion
; sorry for the confusion! The motion
doc comments should probably get removed at some point.
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.
Ok, thank you!
src/viam/components/arm/arm.py
Outdated
@@ -72,7 +78,11 @@ async def move_to_position( | |||
await my_arm.move_to_position(pose=examplePose) | |||
|
|||
Args: | |||
pose (Pose): The destination Pose for the arm. | |||
pose (Pose): The destination ``Pose`` for the arm. The ``Pose`` is composed of values for location and orientation with respect to the origin. |
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.
The linter is complaining about this line (and some others) that they're too long; can we cut this down or break it into multiple lines?
@stuqdog do you know about this? No worries if not |
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.
LGTM, thank you!
Questions: