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 5ed69594f7 Minor docs updates CTR
5ed69594f7 is described below
commit 5ed69594f7bf45a1ed16dffae1600dbccfd2d72f
Author: Stephen Mallette <[email protected]>
AuthorDate: Mon Mar 30 16:09:02 2026 +0000
Minor docs updates CTR
---
.../dev/developer/development-environment.asciidoc | 2 +-
docs/src/dev/io/graphbinary.asciidoc | 2 +-
docs/src/dev/provider/gremlin-semantics.asciidoc | 22 +++++++++++-----------
docs/src/recipes/anti-patterns.asciidoc | 2 +-
docs/src/reference/gremlin-applications.asciidoc | 4 ++--
docs/src/reference/gremlin-variants.asciidoc | 4 ++--
.../reference/implementations-tinkergraph.asciidoc | 4 ++--
docs/src/reference/the-traversal.asciidoc | 8 ++++----
docs/src/upgrade/release-4.x.x.asciidoc | 6 +++---
9 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/docs/src/dev/developer/development-environment.asciidoc
b/docs/src/dev/developer/development-environment.asciidoc
index 7f37f421ff..b7b419d46c 100644
--- a/docs/src/dev/developer/development-environment.asciidoc
+++ b/docs/src/dev/developer/development-environment.asciidoc
@@ -306,7 +306,7 @@ built. Consequently, the scripts `bin/generate-home.sh` and
`bin/publish-home.sh
installed. Check the root `pom.xml` for the `runtime.node.version` property
for the minimum version required. This is
covered in more detail in the <<site,Site>> section.
-A fast way to test `grelin-mcp` after doing a build is to use
link:https://modelcontextprotocol.io/docs/tools/inspector[@modelcontextprotocol/inspector]
+A fast way to test `gremlin-mcp` after doing a build is to use
link:https://modelcontextprotocol.io/docs/tools/inspector[@modelcontextprotocol/inspector]
which will start up the Gremlin MCP server and present a browser-based tool to
use the commands. It is most easily
launched with `npx` as follows:
diff --git a/docs/src/dev/io/graphbinary.asciidoc
b/docs/src/dev/io/graphbinary.asciidoc
index 3ea37cbf4e..3b610a4d2e 100644
--- a/docs/src/dev/io/graphbinary.asciidoc
+++ b/docs/src/dev/io/graphbinary.asciidoc
@@ -35,7 +35,7 @@ Where:
* `{type_code}` is a single unsigned byte representing the type number.
* `{type_info}` is an optional sequence of bytes providing additional
information of the type represented. This is
-specially useful for representing complex and custom types.
+especially useful for representing complex and custom types.
* `{value_flag}` is a single byte providing information about the value. Each
type may have its own specific flags so
see each type for more details. Generally, flags have the following meaning:
** `0x00` The value is `non-null`, which means it is followed by a `{value}`.
diff --git a/docs/src/dev/provider/gremlin-semantics.asciidoc
b/docs/src/dev/provider/gremlin-semantics.asciidoc
index 0e32cd5c8f..446472f03e 100644
--- a/docs/src/dev/provider/gremlin-semantics.asciidoc
+++ b/docs/src/dev/provider/gremlin-semantics.asciidoc
@@ -54,7 +54,7 @@ NOTE: TinkerPop has a bit of a JVM-centric view of types as
it was developed wit
Graph providers may not support all of these types depending on the
architecture and implementation. Therefore
TinkerPop must provide a way for Graph providers to override the behavior
while it has its own default behavior. Also
-when some types are not supported Graph providers needs to map unsupported
types into supported types internally. This
+when some types are not supported Graph providers need to map unsupported
types into supported types internally. This
mapping can be done in either information-preserving manner or non-preserving
manner. Graph providers must tell which
mapping they support through `Graph.Features` as well as which types they
support.
@@ -1115,8 +1115,8 @@ each traversal, although providers can choose to re-use
instances across travers
Providers using the reference implementation can return `Traverser` output or
raw value output - the `CallStep` will
handle either case appropriately. In the case of a `Streaming` service, where
there is exactly one input to each
call, the reference implementation can preserve `Path` information by
splitting the input `Traverser` when receiving
-raw output from the call. In the case of `Barrier` however, it is the
responsiblity of the `Service` to preserve
-`Path` information by producing its own `Traversers` as output, since the
`CallStep` cannot match input and ouput
+raw output from the call. In the case of `Barrier` however, it is the
responsibility of the `Service` to preserve
+`Path` information by producing its own `Traversers` as output, since the
`CallStep` cannot match input and output
across a barrier. The ability to split input `Traversers` and generate output
is provided by the reference
implementation's `ServiceCallContext` object, which is supplied to the
`Service` during execution.
@@ -1127,15 +1127,15 @@ There are three execution methods in the reference
implementation service call A
* `execute(ServiceCallContext, TraverserSet, Map)` - execute a service call
mid-traversal barrier
The Map is the merged collection of all static and dynamic parameters. In the
case of `Barrier` execution, notice
-that there is one `Map` for many input. Since the `call()` API support dynamic
parameters, this implies that all
+that there is one `Map` for many input. Since the `call()` API supports
dynamic parameters, this implies that all
input must reduce to the same set of parameters for `Barrier` execution. In
the reference implementation, if more
-than one parameter set is detected, this will cause an execution and the
traversal will halt. Providers that
+than one parameter set is detected, this will cause an exception and the
traversal will halt. Providers that
implement their own version of a call operation may decide on other strategies
to handle this case - for example
it may be sensible to group traversers by Map in the case where multiple
parameter sets are detected.
The no-arg version of the `call()` API is meant to be a directory service and
should only be used to start a traversal.
-The reference implementation provides a default version, with will produce a
list of service names or a service
-description if run with `verbose=true`. Providers using the own implementation
of the call operation must provide their
+The reference implementation provides a default version, which will produce a
list of service names or a service
+description if run with `verbose=true`. Providers using their own
implementation of the call operation must provide their
own directory listing service with the service name `"--list"`.
*Exceptions*
@@ -1287,7 +1287,7 @@
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#coin-step[reference]
*Description:* Concatenates the incoming String traverser with the input
String arguments, and return the joined String.
-*Syntax:* `concat()` | `concat(String... concatStrings)` | `concat(Traversal
concatTraveral, Traversal... otherConcatTraverals)`
+*Syntax:* `concat()` | `concat(String... concatStrings)` | `concat(Traversal
concatTraversal, Traversal... otherConcatTraversals)`
[width="100%",options="header"]
|=========================================================
@@ -1299,9 +1299,9 @@
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#coin-step[reference]
* `concatStrings` - Varargs of `String`. If one or more String values are
provided, they will be concatenated together
with the incoming traverser. If no argument is provided, the String value from
the incoming traverser is returned.
-* `concatTraveral` - A `Traversal` whose must value resolve to a `String`. The
first result returned from the traversal will
+* `concatTraversal` - A `Traversal` whose value must resolve to a `String`.
The first result returned from the traversal will
be concatenated with the incoming traverser.
-* `otherConcatTraverals` - Varargs of `Traversal`. Each `Traversal` value must
resolve to a `String`. The first result
+* `otherConcatTraversals` - Varargs of `Traversal`. Each `Traversal` value
must resolve to a `String`. The first result
returned from each traversal will be concatenated with the incoming traverser
and the previous traversal arguments.
Any `null` String values will be skipped when concatenated with non-`null`
String values. If two `null` value are
@@ -1641,7 +1641,7 @@
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#groupcount-step[referenc
=== length()
*Description:* Returns the length of the incoming string or list, if
`Scope.local` is specified, returns
-the length of each string elements inside incoming list traverser.
+the length of each string element inside incoming list traverser.
*Syntax:* `length()` | `length(Scope scope)`
diff --git a/docs/src/recipes/anti-patterns.asciidoc
b/docs/src/recipes/anti-patterns.asciidoc
index 1abaa7d7b2..18dde78dd6 100644
--- a/docs/src/recipes/anti-patterns.asciidoc
+++ b/docs/src/recipes/anti-patterns.asciidoc
@@ -58,7 +58,7 @@ for (relation in relations) {
from("p${relation.from}").
to("p${relation.to}")
} ; []
-traversalAsString = traversalAsString = t.gremlinLang.getGremlin() ; []
+traversalAsString = t.gremlinLang.getGremlin() ; []
[ "Traversal String Length": traversalAsString.length()
, "Traversal Preview": traversalAsString.replaceFirst(/^(.{104}).*(.{64})$/,
'$1 ... $2') ]
----
diff --git a/docs/src/reference/gremlin-applications.asciidoc
b/docs/src/reference/gremlin-applications.asciidoc
index acd299a837..5096cf5e6a 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -590,7 +590,7 @@ recognized by the serializer used by the driver, there will
be an error. The mos
problems include:
* Connecting to a graph that requires custom serializers, such as the ones
JanusGraph provides for its relation
-identifier. Always be take time to get to know the graph database that's been
chosen to determine if there are customer
+identifier. Always take time to get to know the graph database that's been
chosen to determine if there are custom
serializers that need to be registered to the server or the driver.
* Driver versions that don't match server versions can sometimes create
scenarios where serialization failures will
present themselves. TinkerPop typically does the most testing on drivers and
servers of the same version and therefore
@@ -2087,7 +2087,7 @@ params.put("#jsr223.groovy.engine.keep.globals", "soft");
client.submit("def addItUp(x,y){x+y}", params);
----
-In cases where maintaining the expense of the global function cache is
unecessary this cache can be disabled with the
+In cases where maintaining the expense of the global function cache is
unnecessary this cache can be disabled with the
`globalFunctionCacheEnabled` configuration on the
`GroovyCompilerGremlinPlugin`.
Gremlin Server also has a "class map" cache which holds compiled scripts which
helps avoid recompilation costs on
diff --git a/docs/src/reference/gremlin-variants.asciidoc
b/docs/src/reference/gremlin-variants.asciidoc
index d7201de092..f3144c1ff9 100644
--- a/docs/src/reference/gremlin-variants.asciidoc
+++ b/docs/src/reference/gremlin-variants.asciidoc
@@ -837,7 +837,7 @@ Please see the
link:https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/
[[gremlin-java-transactions]]
=== Transactions
-IMPORTANT: 4.0.0-beta.1 Release - Transactions with Java isn't currently
supported.
+IMPORTANT: 4.0.0-beta.1 Release - Transactions with Java aren't currently
supported.
[[gremlin-java-serialization]]
=== Serialization
@@ -1085,7 +1085,7 @@ to "g" and "g1" and "g2" are automatically rebound into
"g" on the server-side.
==== RequestInterceptor
-Gremlin-Java allows for modification of the underlying HTTP request through
the use of `RequestInteceptors`. This is
+Gremlin-Java allows for modification of the underlying HTTP request through
the use of `RequestInterceptors`. This is
intended to be an advanced feature which means that you will need to
understand how the implementation works in order
to safely utilize it. Gremlin-Java is written in a way that you should be able
to interact with a TinkerPop-enabled
server without having to use interceptors. This is intended for cases where
the server has special capabilities.
diff --git a/docs/src/reference/implementations-tinkergraph.asciidoc
b/docs/src/reference/implementations-tinkergraph.asciidoc
index 1dc7b122f1..3d4155f2f4 100644
--- a/docs/src/reference/implementations-tinkergraph.asciidoc
+++ b/docs/src/reference/implementations-tinkergraph.asciidoc
@@ -277,7 +277,7 @@ public class GraphService {
// suitable test graph replacement for our actual production graph.
public class GraphServiceTest {
private static final TinkerTransactionGraph graph =
TinkerTransactionGraph.open();
- private static final GraphTraversalSource g = traversal.with(graph);
+ private static final GraphTraversalSource g = traversal().with(graph);
private static final GraphService service = new GraphService(g);
@Test
@@ -297,7 +297,7 @@ public class GraphServiceTest {
// with this approach you could also configure your production graph directly
or use custom
// build options to trigger different test configurations for a more dynamic
approach
public class GraphServiceTest {
- private static final GraphTraversalSource g = traversal.with(
+ private static final GraphTraversalSource g = traversal().with(
new DriverRemoteConnection('ws://localhost:8182/gremlin'));
private static final GraphService service = new GraphService(g);
diff --git a/docs/src/reference/the-traversal.asciidoc
b/docs/src/reference/the-traversal.asciidoc
index 019dff672a..ed1e81f14c 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -1133,7 +1133,7 @@ it is possible to implement two different types of
semantics: if-then-else (cond
==== If-Then-Else
-The if-the-else semantics of `choose()` evaluate a predicate traversal and
route the traverser to either the "true"
+The if-then-else semantics of `choose()` evaluate a predicate traversal and
route the traverser to either the "true"
branch or the "false" branch based on the result.
[gremlin-groovy,modern]
@@ -1163,7 +1163,7 @@ g.V().choose(hasLabel('person'), out('created'),
identity()).values('name') <2>
----
<1> If the vertex is a person, emit the vertices they created, else emit the
vertex.
-<2> if-the-else with an `identity()` on the false-branch is equivalent to
if-then with no false-branch.
+<2> if-then-else with an `identity()` on the false-branch is equivalent to
if-then with no false-branch.
==== Switch
@@ -1241,7 +1241,7 @@ g.V().choose(values('age')).
<1> For vertices with age between 26-30, return the name. For vertices with
age outside that range, return the name.
For vertices without an age property, return the label.
<2> For people with no outgoing "knows" edges, return 'noFriends', otherwise
return 'hasFriends'.
-<3> Use `none()` step in combination with `Pick.none` and `Pick.unproductive`
to filter unproductive traversals and
+<3> Use `discard()` step in combination with `Pick.none` and
`Pick.unproductive` to filter unproductive traversals and
unmatched values.
IMPORTANT: It is important to think of `choose()` as a branching step and not
a filter. The if-then semantics can
@@ -1379,7 +1379,7 @@ desired strings between arguments.
*Additional References*
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#concat(java.lang.String)++[`concat(String...)`]
-link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#concat(org.apache.tinkerpop.gremlin.process.traversal.Traversal,org.apache.tinkerpop.gremlin.process.traversal.Traversal...)++[`concat(Taversal,
Traversal...)`]
+link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#concat(org.apache.tinkerpop.gremlin.process.traversal.Traversal,org.apache.tinkerpop.gremlin.process.traversal.Traversal...)++[`concat(Traversal,
Traversal...)`]
link:++https://tinkerpop.apache.org/docs/x.y.z/dev/provider/#concat-step++[`Semantics`]
[[conjoin-step]]
diff --git a/docs/src/upgrade/release-4.x.x.asciidoc
b/docs/src/upgrade/release-4.x.x.asciidoc
index cabcd16c3d..43bd657f8c 100644
--- a/docs/src/upgrade/release-4.x.x.asciidoc
+++ b/docs/src/upgrade/release-4.x.x.asciidoc
@@ -58,7 +58,7 @@ All JavaScript projects (`gremlin-javascript`, `gremlin-mcp`,
`gremlint`) have b
==== ResultQueue Removed
-The public class `ResultQueue` in `gremlin-driver` has been removed. It's
functionality has been merged into
+The public class `ResultQueue` in `gremlin-driver` has been removed. Its
functionality has been merged into
`ResultSet`. Users of this class should reference the newly added methods of
`ResultSet` instead.
==== neo4j-gremlin Removed
@@ -116,7 +116,7 @@
g.V().has('name','Alice').out('knows').out('knows').where(neq('Alice')).values('
TinkerPop has generally upgraded to SLF4j 2.x which brings with it some
important changes to log initialization which
may affect user applications that are upgrading from TinkerPop 3.x. Please see
the
-[SLF4j documentation](https://www.slf4j.org/faq.html#changesInVersion200) that
explains the differences and how they
+link:https://www.slf4j.org/faq.html#changesInVersion200[SLF4j documentation]
that explains the differences and how they
might apply.
==== Configuration changes
@@ -299,7 +299,7 @@ additional features that are not well suited to the Gherkin
style. Providers who
Please see the
link:https://github.com/apache/tinkerpop/blob/4.0.0-beta.1/CHANGELOG.asciidoc#release-4-0-0-beta-1[changelog]
for a
complete list of all the modifications that are part of this release.
-NOTE: 4.0.0-beta.1 is a beta/milestone release. It is for meant as a preview
version to try out the new HTTP API
+NOTE: 4.0.0-beta.1 is a beta/milestone release. It is meant as a preview
version to try out the new HTTP API
features in the server and drivers (Java/Python only). As this is a beta
version only, you can expect breaking changes to
occur in future betas for 4.0.0 on the way to its General Availability
release. Items that have important
limitations and constraints pertinent to this beta will be highlighted through
the documentation inside an
