Skip to content

Commit 8a40642

Browse files
committed
CTR fix & re-order asString() in semantics doc
1 parent ac7f0ff commit 8a40642

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

docs/src/dev/provider/gremlin-semantics.asciidoc

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -799,6 +799,35 @@ If no type token is provided, the incoming number remains unchanged.
799799
See: link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/AsNumberStep.java[source],
800800
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#asNumber-step[reference]
801801
802+
[[asString-step]]
803+
=== asString()
804+
805+
*Description:* Returns the value of incoming traverser as strings, or if `Scope.local` is specified, returns each element inside
806+
incoming list traverser as string.
807+
808+
*Syntax:* `asString()` | `asString(Scope scope)`
809+
810+
[width="100%",options="header"]
811+
|=========================================================
812+
|Start Step |Mid Step |Modulated |Domain |Range
813+
|N |Y |N |`any` |`String`/`List`
814+
|=========================================================
815+
816+
*Arguments:*
817+
818+
* `scope` - Determines the type of traverser it operates on. Both scopes will operate on the level of individual traversers.
819+
The `global` scope will operate on individual traverser, casting all (except `null`) to string. The `local` scope will behave like
820+
`global` for everything except lists, where it will cast individual non-`null` elements inside the list into string and return a
821+
list of string instead.
822+
823+
*Exceptions*
824+
825+
* If the incoming traverser is a `null` value then an `IllegalArgumentException` will be thrown.
826+
827+
See: link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/AsStringGlobalStep.java[source],
828+
link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/AsStringLocalStep.java[source (local)],
829+
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#asString-step[reference]
830+
802831
[[barrier-step]]
803832
=== barrier()
804833
@@ -1002,36 +1031,6 @@ None
10021031
See: link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/SideEffectCapStep.java[source],
10031032
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#cap-step[reference]
10041033
1005-
[[asString-step]]
1006-
=== asString()
1007-
1008-
*Description:* Returns the value of incoming traverser as strings, or if `Scope.local` is specified, returns each element inside
1009-
incoming list traverser as string.
1010-
1011-
*Syntax:* `asString()` | `asString(Scope scope)`
1012-
1013-
[width="100%",options="header"]
1014-
|=========================================================
1015-
|Start Step |Mid Step |Modulated |Domain |Range
1016-
|N |Y |N |`any` |`String`/`List`
1017-
|=========================================================
1018-
1019-
*Arguments:*
1020-
1021-
* `scope` - Determines the type of traverser it operates on. Both scopes will operate on the level of individual traversers.
1022-
The `global` scope will operate on individual traverser, casting all (except `null`) to string. The `local` scope will behave like
1023-
`global` for everything except lists, where it will cast individual non-`null` elements inside the list into string and return a
1024-
list of string instead.
1025-
1026-
Null values from the incoming traverser are not processed and remain as null when returned.
1027-
1028-
*Exceptions*
1029-
* If the incoming traverser is a `null` value then an `IllegalArgumentException` will be thrown.
1030-
1031-
See: link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/AsStringGlobalStep.java[source],
1032-
link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/AsStringLocalStep.java[source (local)],
1033-
link:https://tinkerpop.apache.org/docs/x.y.z/reference/#asString-step[reference]
1034-
10351034
[[call-step]]
10361035
=== call()
10371036

0 commit comments

Comments
 (0)