Add VelocityPolygon docs#510
Conversation
Signed-off-by: nelson <kaichie.lee@gmail.com>
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Outdated
Show resolved
Hide resolved
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Outdated
Show resolved
Hide resolved
|
I think also this comment wasn't documented:
Missing docs that the first polygon, if many cover a range, is used first. That should be addressed in the tutorial, configuration guide, and readme |
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: nelson <kaichie.lee@gmail.com>
|
@kaichie look at the rendering: there's something wrong with the fformatting or your new section https://output.circle-artifacts.com/output/job/2288c871-ef24-4297-8327-cddd9214fe45/artifacts/0/html/configuration/packages/collision_monitor/configuring-collision-monitor-node.html |
|
|
||
| VelocityPolygon parameters | ||
| ========================== | ||
|
|
There was a problem hiding this comment.
Add a line here that all previous parameters apply, in addition to the following unique parameters for velocity polygons
migration/Iron.rst
Outdated
| Add VelocityPolygon in Collision Monitor | ||
| **************************************** | ||
|
|
||
| `PR #3708 <https://github.com/ros-planning/navigation2/pull/3708>`_ adds ``VelocityPolgon`` type in Collision Monitor. This allows the user to setup multiple polygons to cover the range of the robot's velocity limits. For example, the user can configure different polygons for rotation, moving forward, or moving backward. The Collision Monitor will check the robot's velocity against each sub polygon to determine the approriate polygon to be used for collision checking. |
There was a problem hiding this comment.
Add :ref: to the tutorial update on it
Signed-off-by: nelson <kaichie.lee@gmail.com>
I could not see anything obvious that is wrong with the table formatting. Looks like it is affected by the length of the parameter name on the left. Not familiar with this but will continue looking later, appreciate any tips here. |
|
I have no particular suggestion. given that this is already a problem, I don't expect you to fix it (though that would be ideal), I would however expect you to make it less bad. It seems like reducing the If that's not quite enough, seeing what formatting is not properly IDing these tables max width |
Signed-off-by: nelson <kaichie.lee@gmail.com>
This reverts commit bdacb7d.
Signed-off-by: nelson <kaichie.lee@gmail.com>
|
Attempted to fix it in this commit, looks okay on the collision monitor page, but causes the table on other pages to look a bit funny, for example, here. Reverted and updated the parameter length to |
|
OK, works for me for now |
For ros-navigation/navigation2#3708