Skip to content

Fix path planning doc typo and DijkstraPlanner docstring - #1517

Open
anweshasd5-stack wants to merge 1 commit into
AtsushiSakai:masterfrom
anweshasd5-stack:improve-astar-docs
Open

anweshasd5-stack wants to merge 1 commit into
AtsushiSakai:masterfrom
anweshasd5-stack:improve-astar-docs

Conversation

@anweshasd5-stack

Copy link
Copy Markdown

Reference issue

N/A (minor documentation and docstring cleanup)

What does this implement/fix?

  • Fixed a minor grammatical typo in docs/modules/5_path_planning/path_planning_main.rst ("search feasible" -> "search for a feasible").
  • Updated the DijkstraPlanner.__init__ docstring in PathPlanning/Dijkstra/dijkstra.py to accurately reference Dijkstra planning instead of A* planning and match the robot_radius parameter name.

Additional information

  • Ran pytest tests/test_dijkstra.py locally and confirmed all existing tests pass.

CheckList

  • Did you add an unittest for your new example or defect fix? (Existing tests verified)
  • Did you add documents for your new example?
  • All CIs are green? (You can check it after submitting)

This branch has not been deployed

No deployments
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.

1 participant