tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spmalle...@apache.org
Subject [1/2] tinkerpop git commit: Some spelling/grammar fixes and subtitle for P IO values CTR
Date Wed, 24 Jan 2018 13:35:22 GMT
Repository: tinkerpop
Updated Branches:
  refs/heads/master 082432d24 -> 4788420bf


Some spelling/grammar fixes and subtitle for P IO values CTR


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/d5b6ebb0
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/d5b6ebb0
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/d5b6ebb0

Branch: refs/heads/master
Commit: d5b6ebb08229be07761d11c3a4065f21a8dcddd3
Parents: 08391f8
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Wed Jan 24 08:30:14 2018 -0500
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Wed Jan 24 08:30:14 2018 -0500

----------------------------------------------------------------------
 docs/src/dev/io/graphson.asciidoc | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/d5b6ebb0/docs/src/dev/io/graphson.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/io/graphson.asciidoc b/docs/src/dev/io/graphson.asciidoc
index 4b1d219..7324cee 100644
--- a/docs/src/dev/io/graphson.asciidoc
+++ b/docs/src/dev/io/graphson.asciidoc
@@ -75,7 +75,7 @@ file.withWriter { writer ->
   writer.write("=== ResponseMessage\n\n")
   msg = ResponseMessage.build(UUID.fromString("41d2e28a-20a4-4ab0-b379-d810dede3786")).
                         code(org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode.AUTHENTICATE).create()
-  writer.write(toJson(msg, "Authentication Challenge", "When authentication is enabled, an
initial request to the server will result in an authentication challenge. The typical response
message will appear as follows, but handling it could be different dependending on the SASL
implementation (e.g. multiple challenges maybe requested in some cases, but not in the default
provided by Gremlin Server)."))
+  writer.write(toJson(msg, "Authentication Challenge", "When authentication is enabled, an
initial request to the server will result in an authentication challenge. The typical response
message will appear as follows, but handling it could be different dependending on the SASL
implementation (e.g. multiple challenges may be requested in some cases, but not in the default
provided by Gremlin Server)."))
   msg = ResponseMessage.build(UUID.fromString("41d2e28a-20a4-4ab0-b379-d810dede3786")).
                         code(org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode.SUCCESS).
                         result(Arrays.asList(graph.vertices().next())).create()
@@ -147,9 +147,9 @@ file.withWriter { writer ->
   metrics = new org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics(tm.getMetrics(0));
   metrics.addNested(new org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics(tm.getMetrics(1)));
   writer.write(toJson(metrics, "Metrics"))
-  writer.write(toJson(P.gt(0), "P"))
-  writer.write(toJson(P.within(1), "P within"))
-  writer.write(toJson(P.without(1,2), "P without"))
+  writer.write(toJson(P.gt(0), "P", "`P` expects a single value of a `List` of values. There
is special handling for `List` values when it comes to `within`, `without`, `inside`, `outside`
and `between`. For `inside`, `outside` and `between`, the expectation is that the collection
contain two objects (the rest will be ignored) and those two objects become the arguments
to those methods. For `within` and `without`, these methods will accept an arbitrary number
of objects in the collection."))
+  writer.write(toJson(P.within(1), "P within", "Please see <<p,P>> for additional
information on `within`."))
+  writer.write(toJson(P.without(1,2), "P without", "Please see <<p,P>> for additional
information on `within`."))
   writer.write(toJson(P.gt(0).and(P.lt(10)), "P and"))
   writer.write(toJson(P.gt(0).or(P.within(-1, -10, -100)), "P or"))
   writer.write(toJson(Scope.local, "Scope"))
@@ -183,7 +183,7 @@ file.withWriter { writer ->
   writer.write("=== ResponseMessage\n\n")
   msg = ResponseMessage.build(UUID.fromString("41d2e28a-20a4-4ab0-b379-d810dede3786")).
                         code(org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode.AUTHENTICATE).create()
-  writer.write(toJson(msg, "Authentication Challenge", "When authentication is enabled, an
initial request to the server will result in an authentication challenge. The typical response
message will appear as follows, but handling it could be different dependending on the SASL
implementation (e.g. multiple challenges maybe requested in some cases, but no in the default
provided by Gremlin Server)."))
+  writer.write(toJson(msg, "Authentication Challenge", "When authentication is enabled, an
initial request to the server will result in an authentication challenge. The typical response
message will appear as follows, but handling it could be different dependending on the SASL
implementation (e.g. multiple challenges may be requested in some cases, but not in the default
provided by Gremlin Server)."))
   msg = ResponseMessage.build(UUID.fromString("41d2e28a-20a4-4ab0-b379-d810dede3786")).
                         code(org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode.SUCCESS).
                         result(Arrays.asList(graph.vertices().next())).create()
@@ -1270,7 +1270,7 @@ The following `RequestMessage` is an example of a sessionless request
for a scri
 
 ==== Authentication Challenge
 
-When authentication is enabled, an initial request to the server will result in an authentication
challenge. The typical response message will appear as follows, but handling it could be different
dependending on the SASL implementation (e.g. multiple challenges maybe requested in some
cases, but no in the default provided by Gremlin Server).
+When authentication is enabled, an initial request to the server will result in an authentication
challenge. The typical response message will appear as follows, but handling it could be different
dependending on the SASL implementation (e.g. multiple challenges may be requested in some
cases, but not in the default provided by Gremlin Server).
 
 [source,json]
 ----
@@ -3558,6 +3558,8 @@ The following `Bytecode` example represents the traversal of `g.V().hasLabel('pe
 
 ==== P
 
+`P` expects a single value of a `List` of values. There is special handling for `List` values
when it comes to `within`, `without`, `inside`, `outside` and `between`. For `inside`, `outside`
and `between`, the expectation is that the collection contain two objects (the rest will be
ignored) and those two objects become the arguments to those methods. For `within` and `without`,
these methods will accept an arbitrary number of objects in the collection.
+
 [source,json]
 ----
 {
@@ -3574,6 +3576,8 @@ The following `Bytecode` example represents the traversal of `g.V().hasLabel('pe
 
 ==== P within
 
+Please see <<_p,P>> for additional information on `within`.
+
 [source,json]
 ----
 {
@@ -3590,6 +3594,8 @@ The following `Bytecode` example represents the traversal of `g.V().hasLabel('pe
 
 ==== P without
 
+Please see <<_p,P>> for additional information on `within`.
+
 [source,json]
 ----
 {
@@ -4080,7 +4086,7 @@ The following `RequestMessage` is an example of a sessionless request
for a scri
 
 ==== Authentication Challenge
 
-When authentication is enabled, an initial request to the server will result in an authentication
challenge. The typical response message will appear as follows, but handling it could be different
dependending on the SASL implementation (e.g. multiple challenges maybe requested in some
cases, but no in the default provided by Gremlin Server).
+When authentication is enabled, an initial request to the server will result in an authentication
challenge. The typical response message will appear as follows, but handling it could be different
dependending on the SASL implementation (e.g. multiple challenges maybe requested in some
cases, but not in the default provided by Gremlin Server).
 
 [source,json]
 ----


Mime
View raw message