From 5a6de49695691329394deb7551cf15be6c59f84e Mon Sep 17 00:00:00 2001
From: Grant Hur <22hurg@sjchrisitan.org>
Date: Sun, 7 May 2023 13:25:03 -0700
Subject: [PATCH] Add Docstrings to paths.py

---
 arcade/paths.py | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/arcade/paths.py b/arcade/paths.py
index 5a4c1d4bb..dc443ecab 100644
--- a/arcade/paths.py
+++ b/arcade/paths.py
@@ -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