-
Notifications
You must be signed in to change notification settings - Fork 43
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-1880: Document new data client methods #2593
Conversation
Overall readability score: 55.64 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
e53e73a
to
b5a1127
Compare
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.
All parameter names should be monospace, and all parameter types usually get links
Co-authored-by: JessamyT <[email protected]>
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.
I should've said first round sorry: In most of the code examples we have example parameter values of a representative form, i.e. for a machine ID we have "abcd-1234xyz-8765z-123abc"
or whatever... [opt] Consider swapping "<dataset-id>"
and similar for realistic examples since the description says what the fields are already, so examples might be more helpful. Otherwise LGTM.
include_file_data=False | ||
) | ||
|
||
my_binary_ids = [] |
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.
Is this meant to be left empty?
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.
read the following lines (yes, IDs are being appended to the array there)
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2593 |
No description provided.