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-3341: Add missing python methods and fix check #3858

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Jan 16, 2025

Adding a variety of methods that have been added to the python SDK docs. Also fixing the check that checks whether there is anything in the python sdk docs we're not covering

Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 2cfa714
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/678a7dba90a4140008a6013f
😎 Deploy Preview https://deploy-preview-3858--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jan 16, 2025
Copy link
Collaborator

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry-- meeting with rand rn and realized this is being deprecated. will result in changes to camera (no more webcam drop down)

@@ -443,6 +446,7 @@ robot,FrameSystemConfig,,get_frame_system_config,FrameSystemConfig,
robot,TransformPose,,transform_pose,TransformPose,
robot,TransformPCD,,,TransformPointCloud,
robot,StreamStatus,,,,
robot,DiscoverComponents,,discover_components,DiscoverComponents,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually this is being deprecated-- circa rand rn.

Suggested change
robot,DiscoverComponents,,discover_components,DiscoverComponents,

@@ -9,6 +9,7 @@
| [`FrameSystemConfig`](/dev/reference/apis/robot/#framesystemconfig) | Get the configuration of the frame system of a given machine. |
| [`TransformPose`](/dev/reference/apis/robot/#transformpose) | Transform a given source Pose from the original reference frame to a new destination reference frame. |
| [`TransformPCD`](/dev/reference/apis/robot/#transformpcd) | Transforms the pointcloud to the desired frame in the robot's frame system. |
| [`DiscoverComponents`](/dev/reference/apis/robot/#discovercomponents) | Get a list of discovered potential component configurations, for example listing different supported resolutions. Currently only works for some cameras. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

being deprecated

@npentrel npentrel requested a review from sguequierre January 17, 2025 15:56
@viambot
Copy link
Member

viambot commented Jan 17, 2025

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3858

Copy link
Collaborator

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks naomi!

@npentrel npentrel merged commit 0b1050d into viamrobotics:main Jan 17, 2025
13 checks passed
@npentrel npentrel deleted the DOCS-3341 branch January 17, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants