Skip to content

Document NavFn max_cycles_factor - #941

Merged
SteveMacenski merged 2 commits into
ros-navigation:masterfrom
R0xy42:docs-navfn-max-cycles-factor
Aug 6, 2026
Merged

Document NavFn max_cycles_factor#941
SteveMacenski merged 2 commits into
ros-navigation:masterfrom
R0xy42:docs-navfn-max-cycles-factor

Conversation

@R0xy42

@R0xy42 R0xy42 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Basic Info

Info Please fill out this column
Ticket(s) this addresses ros-navigation/navigation2#6308
Does this PR contain AI-generated software? No; this is a documentation-only change. The wording was drafted with AI assistance and reviewed by me.

Description of contribution in a few bullet points

  • Document the new integer max_cycles_factor parameter introduced by Make NavFn path extraction cycle limit configurable navigation2#6308.
  • Explain how the path extraction cycle limit is calculated from the largest costmap dimension.
  • Add a concrete 500 by 400 cell costmap example using the default factor of 4.
  • Add max_cycles_factor: 4 to the NavFn YAML configuration example.

Signed-off-by: Jiarui Zou <jiarui_zou@outlook.com>
@mergify

mergify Bot commented Aug 5, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

Signed-off-by: Jiarui Zou <jiarui_zou@outlook.com>
@SteveMacenski
SteveMacenski merged commit ef3b65d into ros-navigation:master Aug 6, 2026
5 checks passed
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