shortest paths now undirected (#710)

* shortest paths now undirected * david feedback
neo4j-contrib · Apr 2, 2019 · c9574ab · c9574ab
1 parent 975c8ef
commit c9574ab
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/asciidoc/algorithms-path-finding.adoc b/doc/asciidoc/algorithms-path-finding.adoc
@@ -25,6 +25,15 @@ The following path finding algorithms help find the shortest path or evaluate th
 * <<algorithms-random-walk, Random Walk>> (`algo.randomWalk`)
 // end::summary[]
 
+[WARNING]
+====
+As of the 3.4.7.0 release, all the Shortest Path procedures assume that they are being executed on undirected graphs.
+Therefore, the direction of a relationship can be ignored.
+
+If you are running these algorithms on a graph where the direction is important, you can use the `direction` parameter.
+For example, `direction:"INCOMING"` or `direction:"OUTGOING"`.
+====
+
 include::minimum-weight-spanning-tree.adoc[leveloffset=2]
 
 include::shortest-path.adoc[leveloffset=2]