[tinkerpop] branch master updated: Added note to shortestPath() docs to inform it is a Computer step

[sp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git


The following commit(s) were added to refs/heads/master by this push:
     new f46e833  Added note to shortestPath() docs to inform it is a Computer step
     new 06f5213  Merge branch 'tp34'
f46e833 is described below

commit f46e833c850f5f677bdec69bd9ba3f1d950bb465
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Thu Sep 5 06:50:26 2019 -0400

    Added note to shortestPath() docs to inform it is a Computer step
---
 docs/src/reference/the-traversal.asciidoc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc
index eaec561..a7e4834 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -2775,6 +2775,9 @@ link:++http://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/grem
 The `shortestPath()`-step provides an easy way to find shortest non-cyclic paths in a graph. It is configurable
 using the `with()`-modulator with the options given below.
 
+IMPORTANT: The `shortestPath()`-step is a `VertexComputing`-step and as such, can only be used against a graph
+that supports `GraphComputer` (OLAP).
+
 [width="100%",cols="3,3,15,5",options="header"]
 |=========================================================
 | Key | Type | Description | Default