Skip to content

RSDK-6001 - Add Expose Paths project RPC methods #2310

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 31 commits into from
Dec 21, 2023
Merged

RSDK-6001 - Add Expose Paths project RPC methods #2310

merged 31 commits into from
Dec 21, 2023

Conversation

nicksanford
Copy link
Member

@nicksanford nicksanford commented Dec 7, 2023 •
edited
Loading

Ticket

Depends on:
viamrobotics/rdk#3303
viamrobotics/viam-python-sdk#496

Scope doc link: https://viam.atlassian.net/browse/RSDK-4443

  • Update motion docs to describe new motion API
  • Update motion.MoveOnGlobe description, including new request & response values & new non blocking semantics
  • Add motion.StopPlan description
  • Add motion.GetPlan description
  • Add motion.ListPlanStatuses description

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 7, 2023
@viambot
Copy link
Member

viambot commented Dec 7, 2023 •
edited
Loading

Overall readability score: 56.59 (🟢 +0.02)

File Readability
_index.md 60.41 (🟢 +0.73)
motion.md 69.86 (🟢 +8.55)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 60.41 38.72 8.41 13.8 13.69 5.88
  🟢 +0.73 🟢 +0.2 🟢 +0.21 🟢 +0 🔴 -0.06 🟢 +0.13
motion.md 69.86 60.72 9.15 7.8 9.61 8.18
  🟢 +8.55 🟢 +8.46 🟢 +1.04 🟢 +1 🟢 +0.75 🟢 +0.89

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.59 48.55 10.49 12.91 11.91 7.65
  🟢 +0.02 🟢 +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

npentrel
npentrel reviewed Dec 8, 2023
View reviewed changes
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

Thanks for making these changes! I've made some minor changes to copy - please let me know if any of this makes it technically inaccurate and we can work on those

nicksanford and others added 6 commits December 8, 2023 10:48
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
17cf391 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
11584a6 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
09ead25 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
6b8cf17 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
9c7262a 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
@nicksanford @npentrel
Update docs/mobility/motion/_index.md
297d996 
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
npentrel
npentrel approved these changes Dec 8, 2023
View reviewed changes
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

Thanks!

nicksanford
nicksanford commented Dec 8, 2023
View reviewed changes
Copy link
Member Author

@nicksanford nicksanford left a comment

Choose a reason for hiding this comment

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

@npentrel 2 more tweaks (sorry these are somewhat nuanced APIs). LMK if those look good.

@npentrel
Copy link
Collaborator

npentrel commented Dec 8, 2023

sounds good @nicksanford !

This was referenced Dec 8, 2023
Merged
Merged
@nicksanford nicksanford requested a review from raybjork December 11, 2023 16:29
raybjork
raybjork approved these changes Dec 11, 2023
View reviewed changes
Copy link
Contributor

@raybjork raybjork left a comment

Choose a reason for hiding this comment

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

LGTM, just left a couple fixes

nicksanford and others added 3 commits December 11, 2023 17:42
@nicksanford @raybjork
Update docs/mobility/motion/_index.md
c3b78f5 
Co-authored-by: Ray Bjorkman <raymond@viam.com>
@nicksanford @raybjork
Update docs/mobility/motion/_index.md
fd83c26 
Co-authored-by: Ray Bjorkman <raymond@viam.com>
@nicksanford
Merge branch 'main' into RSDK-6001
dc6e269
sguequierre
sguequierre reviewed Dec 12, 2023
View reviewed changes
sguequierre
sguequierre reviewed Dec 12, 2023
View reviewed changes
nicksanford and others added 2 commits December 12, 2023 14:28
@nicksanford @sguequierre
Update static/include/services/apis/motion.md
e0177ae 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
f62b298 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
sguequierre
sguequierre suggested changes Dec 15, 2023
View reviewed changes
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.

This is almost ready to merge, just a couple small things!

nicksanford and others added 8 commits December 15, 2023 10:55
@nicksanford
Merge branch 'main' into RSDK-6001
12d15bb
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
c2539fb 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
c168510 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
4a927c2 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
de6420e 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@nicksanford
fix links
36bc81e
@nicksanford
Merge branch 'main' into RSDK-6001
0a8be57
@nicksanford
respond to feedback
cc12a69
sguequierre
sguequierre approved these changes Dec 15, 2023
View reviewed changes
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 pending one last comment about return description!

sguequierre
sguequierre reviewed Dec 15, 2023
View reviewed changes
@nicksanford @sguequierre
Update docs/mobility/motion/_index.md
f6b1d07 
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@viambot
Copy link
Member

viambot commented Dec 15, 2023

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

@sguequierre sguequierre merged commit e773075 into viamrobotics:main Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@npentrel npentrel npentrel approved these changes

+2 more reviewers

@sguequierre sguequierre sguequierre approved these changes

@raybjork raybjork raybjork approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nicksanford @viambot @npentrel @raybjork @sguequierre