Skip to content

Commit

Permalink
Update path_planners.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
akshayprsd authored Feb 1, 2024
1 parent 1ab3162 commit 3b787cf
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/usage/path_planners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ For example, to add a new planner type called ``NewPlanner``:

::

from pyrobosim.navigation import PlannerBase
from pyrobosim.navigation import PathPlannerBase

class NewPlanner(PlannerBase):
class NewPlanner(PathPlannerBase):
pass

- Create concrete implementations of your planner similar to :py:class:`pyrobosim.navigation.rrt.RRTPlannerPolygon`
Expand All @@ -54,9 +54,9 @@ For example, to add a new planner type called ``NewPlanner``:

::

from pyrobosim.navigation import PlannerBase
from pyrobosim.navigation import PathPlannerBase

class NewPlanner(PlannerBase):
class NewPlanner(PathPlannerBase):

def __init__():
# do implementation selection here.
Expand All @@ -80,5 +80,5 @@ For example, to add a new planner type called ``NewPlanner``:

.. note::

Planner implementations that need to display graphs should provide a `get_graphs()` method and set the `graphs` attribute of `PlannerBase` like in
Planner implementations that need to display graphs should provide a `get_graphs()` method and set the `graphs` attribute of `PathPlannerBase` like in
:py:func:`pyrobosim.navigation.rrt.RRTPlannerPolygon.get_graphs` and :py:func:`pyrobosim.navigation.rrt.RRTPlanner.plan`.

0 comments on commit 3b787cf

Please sign in to comment.