Add warning for multiple paths (#323)

GEMDAT-repos · Jun 3, 2024 · 4972d1a · 4972d1a
1 parent 3c4fdd5
commit 4972d1a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/gemdat/path.py b/src/gemdat/path.py
@@ -298,6 +298,11 @@ def optimal_n_paths(
     (https://doi.org/10.1287/mnsc.17.11.712) and its implementation in NetworkX.
     Only paths that are different by at least min_diff are considered.
 
+    .. warning::
+        Notice that this function in based on networkx.all_shortest_paths, which tends
+        to identify first small variations of the optimal path. A custom graph pruning
+        approach is suggested to accommodate different needs.
+
     Parameters
     ----------
     F_graph : nx.Graph