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-2425: Merge autogen: mlmodel, motion #3091

Merged

Conversation

andf-viam
Copy link
Contributor

@andf-viam andf-viam commented Jul 1, 2024

Merge autogen content for mlmodel, motion.

@andf-viam andf-viam marked this pull request as draft July 1, 2024 23:05
@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 1, 2024
@andf-viam andf-viam marked this pull request as ready for review July 8, 2024 17:52
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

Lgtm but there are two longer choose snippets getting lost. Can you confirm that's intended or open a ticket to add them to upstream?


For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/motion/index.html#viam.services.motion.MotionClient.move).

```python {class="line-numbers linkable-line-numbers"}
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a much better example I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, another split code sample upstream: https://python.viam.dev/autoapi/viam/services/motion/client/index.html#viam.services.motion.client.MotionClient.move

I'll make a PR to fix and re-run with the fixed,staged version. 👍

destination_frame="world")
```

For a more complicated example, take the same scenario and get the pose of the same gripper with respect to an object situated at a location (100, 200, 0) relative to the "world" frame:
Copy link
Collaborator

Choose a reason for hiding this comment

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

This feels like it should also remain - added as a secondary example to the python docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, re-added it back 👍

@@ -0,0 +1,14 @@
<!-- preserve-formatting -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

This type of override makes me very nervous. It'll be outdated so quickly. But we'll address it later

@viambot
Copy link
Member

viambot commented Jul 8, 2024

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

@andf-viam andf-viam merged commit 51f3e39 into viamrobotics:main Jul 8, 2024
8 checks passed
@andf-viam andf-viam deleted the DOCS-2425-autogen-mlmodel-motion branch July 8, 2024 20:26
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