-
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-1781: Handle planning for the zero pose #2589
Conversation
Overall readability score: 55.43 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
docs/mobility/motion/_index.md
Outdated
Each successful `MoveOnMap()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnMap()` call. | ||
|
||
{{< alert title="Info" color="info" >}} | ||
If you specify a goal pose or orientation and the robot's current position is already at the goal post or orientation, `MoveonMap` returns an error. |
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.
small nit: I would say:
If you specify a goal pose and the robot's current position is already within the set `PlanDeviationM`, then `MoveonMap` returns an error.
i.e. if we are within PlanDeviationMM of the goal pose then we do not need to start.
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.
nit change is already at the goal post or orientation
to within planDevM
for both moveonmap and moveonglobe
docs/mobility/motion/_index.md
Outdated
Each successful `MoveOnGlobe()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnGlobe()`. | ||
|
||
{{< alert title="Info" color="info" >}} | ||
If you specify a goal pose or orientation and the robot's current position is already within the set `PlanDeviationM` or orientation, `MoveOnGlobe` returns an error. |
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.
can you please change this to be
If you specify a goal pose and the robot's current position is already within the set `PlanDeviationM`, `MoveOnGlobe` returns an error.
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.
@npentrel this should not include "or orientation"
@nfranczak is this now good to go? |
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.
One comment about removing "or orientation"
from MoveOnGlobe
. Otherwise, LGTM
docs/mobility/motion/_index.md
Outdated
Each successful `MoveOnGlobe()` call returns a unique `ExecutionID` which you can use to identify all plans generated during the `MoveOnGlobe()`. | ||
|
||
{{< alert title="Info" color="info" >}} | ||
If you specify a goal pose or orientation and the robot's current position is already within the set `PlanDeviationM` or orientation, `MoveOnGlobe` returns an error. |
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.
@npentrel this should not include "or orientation"
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2589 |
No description provided.