Docstring fix

caelan · Apr 30, 2021 · e6f2305 · e6f2305
1 parent a981022
commit e6f2305
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/motion_planners/lazy_prm.py b/motion_planners/lazy_prm.py
@@ -125,7 +125,7 @@ def lazy_prm(start, goal, sample_fn, extend_fn, collision_fn, num_samples=100,
  """
  :param start: Start configuration - conf
  :param goal: End configuration - conf
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param max_time: Maximum runtime - float

diff --git a/motion_planners/meta.py b/motion_planners/meta.py
@@ -35,7 +35,7 @@ def random_restarts(solve_fn, start, goal, distance_fn, sample_fn, extend_fn, co
  :param start: Start configuration - conf
  :param goal: End configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param max_time: Maximum runtime - float

diff --git a/motion_planners/prm.py b/motion_planners/prm.py
@@ -259,7 +259,7 @@ def prm(start, goal, distance_fn, sample_fn, extend_fn, collision_fn,
  :param start: Start configuration - conf
  :param goal: End configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :return: Path [q', ..., q"] or None if unable to find a solution

diff --git a/motion_planners/rrt.py b/motion_planners/rrt.py
@@ -51,7 +51,7 @@ def rrt(start, goal_sample, distance_fn, sample_fn, extend_fn, collision_fn, goa
  """
  :param start: Start configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param iterations: Maximum number of iterations - int

diff --git a/motion_planners/rrt_connect.py b/motion_planners/rrt_connect.py
@@ -32,7 +32,7 @@ def rrt_connect(start, goal, distance_fn, sample_fn, extend_fn, collision_fn,
  :param start: Start configuration - conf
  :param goal: End configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param iterations: Maximum number of iterations - int
@@ -73,7 +73,7 @@ def birrt(start, goal, distance_fn, sample_fn, extend_fn, collision_fn, **kwargs
  :param start: Start configuration - conf
  :param goal: End configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param kwargs: Keyword arguments

diff --git a/motion_planners/rrt_star.py b/motion_planners/rrt_star.py
@@ -89,7 +89,7 @@ def rrt_star(start, goal, distance_fn, sample_fn, extend_fn, collision_fn, radiu
  :param start: Start configuration - conf
  :param goal: End configuration - conf
  :param distance_fn: Distance function - distance_fn(q1, q2)->float
- :param sample_fn: Distance function - sample_fn()->conf
+ :param sample_fn: Sample function - sample_fn()->conf
  :param extend_fn: Extension function - extend_fn(q1, q2)->[q', ..., q"]
  :param collision_fn: Collision function - collision_fn(q)->bool
  :param max_time: Maximum runtime - float