Add "Code Link" sections and rename classes for consistency (#1214)

This commit adds "Code Link" sections to documentation across various path planning modules, linking to relevant class and function APIs. Additionally, several class renaming changes were made, such as `Dijkstra` to `DijkstraPlanner` and `eta3_trajectory` to `Eta3SplineTrajectory`, to enhance naming consistency. Minor fixes include file restructuring and image renaming for the RRT module.
This commit is contained in:
Atsushi Sakai
2025-05-05 17:29:45 +09:00
committed by GitHub
parent a38da41baf
commit 73e1c0bebc
33 changed files with 277 additions and 25 deletions

View File

@@ -12,7 +12,7 @@ import math
show_animation = True
class Dijkstra:
class DijkstraPlanner:
def __init__(self, ox, oy, resolution, robot_radius):
"""
@@ -246,7 +246,7 @@ def main():
plt.grid(True)
plt.axis("equal")
dijkstra = Dijkstra(ox, oy, grid_size, robot_radius)
dijkstra = DijkstraPlanner(ox, oy, grid_size, robot_radius)
rx, ry = dijkstra.planning(sx, sy, gx, gy)
if show_animation: # pragma: no cover