Skip to content

Rename max_points to min_points polygon parameter#3513

Merged
SteveMacenski merged 2 commits intoros-navigation:mainfrom
AlexeyMerzlyakov:cm_min_points
Mar 28, 2023
Merged

Rename max_points to min_points polygon parameter#3513
SteveMacenski merged 2 commits intoros-navigation:mainfrom
AlexeyMerzlyakov:cm_min_points

Conversation

@AlexeyMerzlyakov
Copy link
Copy Markdown
Collaborator

Basic Info

Info Please fill out this column
Ticket(s) this addresses #3499
Primary OS tested on Ubuntu 22.04 w/ ROS2 Rolling built from source (from 20230110)
Robotic platform tested on colcon test --packages-select nav2_collision_monitor

Description of contribution in a few bullet points

  • <polygon_name>.max_points parameter was renamed to <polygon_name>.min_points to track its meaning
  • Default value for this parameter was adjusted accordingly to not change default CM's behavior
  • Old <polygon_name>.max_points is still used (to be removed in the future releases), but now with deprecation warning, if parameter was set by developer
  • New testPolygonMaxPoints testcase for max_points deprecated parameter

Description of documentation updates required from your changes

  • Update parameter description on CM parameters page
  • Switch parameters on Tutorial page

Future work that may be required in bullet points

  • Remove the support of <polygon_name>.max_points parameter in the further releases

For Maintainers:

  • Check that any new parameters added are updated in navigation.ros.org
  • Check that any significant change is added to the migration guide
  • Check that any new features OR changes to existing behaviors are reflected in the tuning guide
  • Check that any new functions have Doxygen added
  • Check that any new features have test coverage
  • Check that any new plugins is added to the plugins page
  • If BT Node, Additionally: add to BT's XML index of nodes for groot, BT package's readme table, and BT library lists

@SteveMacenski
Copy link
Copy Markdown
Member

LGTM. Just the docs PR for migration / config guide updates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants