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-1901: Fix python error, add cloudmetadata #2603

Merged
merged 7 commits into from
Mar 5, 2024

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Mar 1, 2024

I think the links will start working tomorrow, so won't merge till then

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

viambot commented Mar 1, 2024

Overall readability score: 55.57 (🔴 -0.01)

File Readability
robot.md 60.33 (🔴 -0.3)
robot.md 63.93 (🔴 -2.75)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
robot.md 60.33 40.55 7.68 14.5 14.2 5.85
  🔴 -0.3 🔴 -0.2 🔴 -0.11 🔴 -0.1 🟢 +0 🟢 +0.02
robot.md 63.93 44.91 9.59 8.8 11.63 7.64
  🔴 -2.75 🔴 -8.26 🔴 -0.23 🔴 -0.2 🔴 -0.11 🔴 -0.17

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.57 47.43 10.65 13.22 12.08 7.61
  🔴 -0.01 🔴 -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


**Returns:**

- None.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@maximpertsov I don't feel like this is correct but there's no info provided in the python sdk docs. I'm a bit confused.

Choose a reason for hiding this comment

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

yeah it's wrong for sure, I'll make a follow-up to fix

Choose a reason for hiding this comment

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

@npentrel npentrel changed the title DOCS-1901: Fix python error DOCS-1901: Fix python error, add cloudmetadata Mar 1, 2024
Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

LGTM!

@viambot
Copy link
Member

viambot commented Mar 5, 2024

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

@npentrel npentrel merged commit 6975a1b into viamrobotics:main Mar 5, 2024
10 checks passed
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Apr 25, 2024
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.

4 participants