From f34033ef8fc1117e1bb9d3aea2ab42ceb2c2ddca Mon Sep 17 00:00:00 2001
From: SCiarella <simoneciarella@gmail.com>
Date: Fri, 31 May 2024 11:18:51 +0200
Subject: [PATCH] Add warning for multiple paths

---
 src/gemdat/path.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/gemdat/path.py b/src/gemdat/path.py
index fa7ec4d1..470d5b0f 100644
--- 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