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-1880: Document new data client methods #2593

Merged
merged 4 commits into from
Mar 1, 2024

Conversation

npentrel
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Feb 27, 2024
@viambot
Copy link
Member

viambot commented Feb 27, 2024

Overall readability score: 55.64 (🟢 +0)

File Readability
data-client.md 70.66 (🟢 +0.39)
data-client.md 78.89 (🔴 -2.19)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
data-client.md 70.66 41.87 6.43 12.3 11.88 5.38
  🟢 +0.39 🟢 +0.1 🟢 +0.11 🔴 -0.1 🟢 +0.05 🟢 +0.08
data-client.md 78.89 45.22 6.48 6.7 9.07 6.73
  🔴 -2.19 🔴 -7.54 🔴 -0.05 🔴 -0.2 🔴 -0.22 🔴 -0.08

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.64 47.55 10.63 13.22 12.08 7.6
  🟢 +0 🔴 -0.02 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Collaborator

@JessamyT JessamyT left a 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

docs/build/program/apis/data-client.md Outdated Show resolved Hide resolved
static/include/services/apis/data-client.md Outdated Show resolved Hide resolved
docs/build/program/apis/data-client.md Outdated Show resolved Hide resolved
docs/build/program/apis/data-client.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@JessamyT JessamyT left a 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 = []
Copy link
Collaborator

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?

Copy link
Collaborator Author

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)

@viambot
Copy link
Member

viambot commented Mar 1, 2024

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

@npentrel npentrel merged commit 14fa48d into viamrobotics:main Mar 1, 2024
9 of 10 checks passed
@npentrel npentrel deleted the python-methods branch March 1, 2024 14:20
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