Skip to content
Snippets Groups Projects
Commit cfca5902 authored by Erik Nygren's avatar Erik Nygren :bullettrain_front:
Browse files

minor documentation update

parent 7e74c267
No related branches found
No related tags found
No related merge requests found
...@@ -21,16 +21,16 @@ def connect_rail(rail_trans: RailEnvTransitions, grid_map: GridTransitionMap, st ...@@ -21,16 +21,16 @@ def connect_rail(rail_trans: RailEnvTransitions, grid_map: GridTransitionMap, st
""" """
Creates a new path [start,end] in `grid_map.grid`, based on rail_trans, and Creates a new path [start,end] in `grid_map.grid`, based on rail_trans, and
returns the path created as a list of positions. returns the path created as a list of positions.
:param rail_trans: :param rail_trans: basic rail transition object
:param grid_map: :param grid_map: grid map
:param start: :param start: start position of rail
:param end: :param end: end position of rail
:param flip_start_node_trans: :param flip_start_node_trans: make valid start position by adding dead-end, empty start if False
:param flip_end_node_trans: :param flip_end_node_trans: make valid end position by adding dead-end, empty end if False
:param respect_transition_validity: :param respect_transition_validity: Only draw rail maps if legal rail elements can be use, False, draw line without respecting rail transitions.
:param a_star_distance_function: :param a_star_distance_function: Define what distance function a-star should use
:param forbidden_cells: :param forbidden_cells: cells to avoid when drawing rail. Rail cannot go through this list of cells
:return: :return: List of cells in the path
""" """
# in the worst case we will need to do a A* search, so we might as well set that up # in the worst case we will need to do a A* search, so we might as well set that up
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment