Skip to content

Add Docstrings to paths.py #1760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2023
Merged

Add Docstrings to paths.py #1760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions arcade/paths.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@ def _spot_is_blocked(position: Point,

def _heuristic(start: Point, goal: Point):
"""
Returns the heuristic of the 2 poitns

Args:
start:
goal:
start: The 1st point to compare
goal: The 2nd point to compare

Returns:

The heuristic of the 2 points
"""
# Use Chebyshev distance heuristic if we can move one square either
# adjacent or diagonal
Expand Down