Add note for A* non-distance metrics

AequilibraE · Nov 23, 2023 · 277c9df · 277c9df
1 parent 5612b20
commit 277c9df
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/aequilibrae/paths/results/path_results.py b/aequilibrae/paths/results/path_results.py
@@ -84,7 +84,9 @@ def compute_path(
         heuristic: Union[str, None] = None,
     ) -> None:
         """
-        Computes the path between two nodes in the network
+        Computes the path between two nodes in the network.
+
+        A* heuristics are currently only valid distance cost fields.
 
         :Arguments:
             **origin** (:obj:`int`): Origin for the path