-
Notifications
You must be signed in to change notification settings - Fork 56
DOCS-2199: Viam Python SDK correctness pass #591
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-2199: Viam Python SDK correctness pass #591
Conversation
Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!
|
@@ -1370,7 +1370,7 @@ async def get_fragment(self, fragment_id: str) -> Fragment: | |||
# Get a fragment and print its name and when it was created. | |||
the_fragment = await cloud.get_fragment( | |||
fragment_id="12a12ab1-1234-5678-abcd-abcd01234567") | |||
print("Name: ", the_fragment.name, "\nCreated on: ", the_fragment.created_on) | |||
print("Name: ", the_fragment.name, "\\nCreated on: ", the_fragment.created_on) |
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.
Not sure if this works, is this how to escape newlines in code examples in autoapi? Alternatively, likely safe to remove the newline. As is it breaks formatting.
Yes, I suspect that Probably also we should have a |
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!
@stuqdog thank so much! Mergin' in! |
First: This PR changes only code comments (that appear in Python SDK docs). No code was harmed in the making of this PR!
Fix straightforward correctness issues that are interfering with automated scraping, such as missing params or returns, formatting (mostly indents), etc. Common issues encountered; fixed:
def
) and parameters (in dedicated Parameters (Args:
) section).str
) todelete_fragment
.NOTES / FURTHER ACTION:
Observed the following further inconsistencies that I cannot fix:
service.html
page entirely (has: arm, mlmodel; 404: motion). Motion appears to be the only resource Viam-wide without one.client.py
file, also at odds with all other service resources, which use{servicename}.py
for these method declarations.timeout
orextra
in Params list (Args:
), but Motion includes them explicitly. Should Motion remove these explicit (inherited?) entries?Thanks Team! Happy to chat or answer any questions; hit me up. Apologies if I guessed wrong on any data types! As always, I greatly appreciate your time!