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-1604: Document Missing Navigation and SLAM methods #2397

Conversation

skyleilani
Copy link
Contributor

Specifically documenting GetPosition (get_position in Python and Position in Go)

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

viambot commented Jan 17, 2024

Overall readability score: 55.83 (🔴 -0.02)

File Readability
_index.md 63.61 (🟢 +0.1)
_index.md 60 (🔴 -0.42)
navigation.md 71.17 (🔴 -3.33)
slam.md 62 (🔴 -5.47)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 63.61 46.67 8.15 13.6 13.22 5.73
  🟢 +0.1 🟢 +0.1 🟢 +0.06 🟢 +0 🔴 -0.06 🟢 +0.02
_index.md 60 48.09 8.48 14 13.33 6.52
  🔴 -0.42 🔴 -0.31 🔴 -0.18 🟢 +0 🟢 +0 🔴 -0.02
navigation.md 71.17 53.07 7.25 7.9 10.24 8.07
  🔴 -3.33 🔴 -7.95 🔴 -0.41 🔴 -0.2 🔴 -0.52 🔴 -0.09
slam.md 62 61.63 10.94 8.3 11.28 8.76
  🔴 -5.47 🔴 -7.95 🔴 -0.96 🔴 -0.4 🔴 -0.87 🔴 -0.22

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.83 47.79 10.58 13.13 12.1 7.62
  🔴 -0.02 🔴 -0.04 🟢 +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
Contributor

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

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

Nice job! Left a couple tiny comments and have the same question about the Go navigation service properties

Copy link
Contributor

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

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

LGTM if links fixed!

@skyleilani skyleilani changed the title DOCS-1604: Document Navigation and SLAM methods DOCS-1604: Document Missing Navigation and SLAM methods Jan 19, 2024
Copy link
Contributor

@jeremyrhyde jeremyrhyde left a comment

Choose a reason for hiding this comment

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

LGTM! Great job, all comments are nitpicks/optional so feel free ignore if you prefer the original!

@viambot
Copy link
Member

viambot commented Jan 19, 2024

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

@skyleilani skyleilani merged commit e85bc39 into viamrobotics:main Jan 19, 2024
10 checks passed
@skyleilani skyleilani deleted the DOCS-1604-Document-NavigationClient-and-SlamClient-methods branch January 19, 2024 20:05
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.

5 participants