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
commit 07976dfb8f35c59ca190eb932154a91171a3f365 Author: Stephen Mallette <[email protected]> AuthorDate: Tue Sep 16 13:17:09 2025 -0400 Fixed formatting in upgrade docs CTR --- docs/src/reference/the-traversal.asciidoc | 21 +++++++++++++++------ docs/src/upgrade/release-3.8.x.asciidoc | 27 +++++++++++++++------------ 2 files changed, 30 insertions(+), 18 deletions(-) diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index b7f8b97a84..68216d1da0 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -853,11 +853,15 @@ link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gre [[asNumber-step]] === AsNumber Step -The `asNumber()`-step (*map*) converts the incoming traverser to the nearest parsable type if no argument is provided, or to the desired numerical type, based on the number token (`N`) provided. +The `asNumber()`-step (*map*) converts the incoming traverser to the nearest parsable type if no argument is provided, +or to the desired numerical type, based on the number token (`N`) provided. -Numerical input will pass through unless a type is specified by the number token. `ArithmeticException` will be thrown for any overflow during narrowing of types. +Numerical input will pass through unless a type is specified by the number token. `ArithmeticException` will be thrown +for any overflow during narrowing of types. -String inputs are parsed into numeric values. By default, the value will be parsed as an integer if it represents a whole number, or as a double if it contains a decimal point. A `NumberFormatException` will be thrown if the string cannot be parsed into a valid number format. +String inputs are parsed into numeric values. By default, the value will be parsed as an integer if it represents a +whole number, or as a double if it contains a decimal point. A `NumberFormatException` will be thrown if the string +cannot be parsed into a valid number format. All other input types will result in `IllegalArgumentException`. @@ -878,17 +882,22 @@ g.inject(33550336).asNumber(N.byte_) <5> [NOTE, caption=Java] ==== -The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Java, and therefore must be referred to in Gremlin with an underscore appended as a suffix: `byte_`, `short_`, `int_`, `long_`, `float_`, `double_`. +The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Java, and therefore must be +referred to in Gremlin with an underscore appended as a suffix: `byte_`, `short_`, `int_`, `long_`, `float_`, `double_`. ==== [NOTE, caption=Groovy & Gremlin Console] ==== -The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Groovy, therefore as the Gremlin Console is Groovy-based, they must be referred to in Gremlin with an underscore appended as a suffix: `byte_`, `short_`, `int_`, `long_`, `float_`, `double_`. +The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Groovy, therefore as the Gremlin +Console is Groovy-based, they must be referred to in Gremlin with an underscore appended as a suffix: `byte_`, +`short_`, `int_`, `long_`, `float_`, `double_`. ==== [NOTE, caption=JavaScript] ==== -The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Javascript, and therefore must be referred to in Gremlin with an underscore appended as a suffix: `byte_`, `short_`, `int_`, `long_`, `float_`, `double_`. +The enums values `byte`, `short`, `int`, `long`, `float`, `double` are reserved word in Javascript, and therefore must +be referred to in Gremlin with an underscore appended as a suffix: `byte_`, `short_`, `int_`, `long_`, `float_`, +`double_`. ==== *Additional References* diff --git a/docs/src/upgrade/release-3.8.x.asciidoc b/docs/src/upgrade/release-3.8.x.asciidoc index e3332284cd..297742f13a 100644 --- a/docs/src/upgrade/release-3.8.x.asciidoc +++ b/docs/src/upgrade/release-3.8.x.asciidoc @@ -32,13 +32,12 @@ complete list of all the modifications that are part of this release. ==== Number Conversion Step -We have been iteratively introducing new language features into Gremlin, with the most recent major additions being string, list and date manipulation -steps introduced in the 3.7 line. In 3.8.0, we are now introducing a number conversion step, `asNumber()`, to bridge -a gap in casting functionalities. +The new `asNumber()` step provides type casting functionality to Gremlin. It serves as an umbrella step that parses +strings and casts numbers into desired types. For the convenience of remote traversals in GLVs, these available types +are denoted by a set of number tokens (`N`). -The new `asNumber()` serves as an umbrella step that parses strings and casts numbers into desired types. For the convenience of remote traversals in GLVs, these number types are denoted by a set of number tokens (`N`). - -This new step will allow users to normalize their data by converting string numbers and mixed numeric types to a consistent format, making it easier to perform downstream mathematical operations. As an example: +This new step will allow users to normalize their data by converting string numbers and mixed numeric types to a +consistent format, making it easier to perform downstream mathematical operations. As an example: [source,text] ---- @@ -55,9 +54,11 @@ gremlin> g.inject(1.0, 2l, 3, "4", "0x5").asNumber().sum().asNumber(N.int_) ==>15 ---- -Semantically, the `asNumber()` step will convert the incoming traverser to a logical parsable type if no argument is provided, or to the desired numerical type, based on the number token (`N`) provided. +Semantically, the `asNumber()` step will convert the incoming traverser to a logical parsable type if no argument is +provided, or to the desired numerical type, based on the number token (`N`) provided. -Numerical input will pass through unless a type is specified by the number token. `ArithmeticException` will be thrown for any overflow as a result of narrowing of types: +Numerical input will pass through unless a type is specified by the number token. `ArithmeticException` will be thrown +for any overflow as a result of narrowing of types: [source,text] ---- @@ -69,7 +70,8 @@ gremlin> g.inject(128).asNumber(N.byte_) ==> ArithmeticException ---- -String input will be parsed. By default, the smalled unit of number to be parsed into is `int` if no number token is provided. `NumberFormatException` will be thrown for any unparsable strings: +String input will be parsed. By default, the smalled unit of number to be parsed into is `int` if no number token is +provided. `NumberFormatException` will be thrown for any unparsable strings: [source,text] ---- @@ -95,8 +97,8 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-3166[TINKERPOP-3166] ==== Boolean Conversion Step -The `asBool()` step bridges another gap in Gremlin's casting functionalities. Users now have the ability to parse strings and -numbers into boolean values, both for normalization and to perform boolean logic with numerical values. +The `asBool()` step bridges another gap in Gremlin's casting functionalities. Users now have the ability to parse +strings and numbers into boolean values, both for normalization and to perform boolean logic with numerical values. [source,text] ---- @@ -813,7 +815,8 @@ transformation of `Date` to `OffsetDateTime` to retain consistency. The semantics have changed for the handling of by modulators to the `valueMap` and `propertyMap` steps. Only one by modulator is required to be accepted and an exception should be thrown when there are more than one `by()` modulators. -The exception thrown should contain the following: `valueMap()` and `propertyMap()` step can only have one by modulator". +The exception thrown should contain the following: `valueMap()` and `propertyMap()` step can only have one by +modulator". See: link:https://issues.apache.org/jira/browse/TINKERPOP-2974[TINKERPOP-2974]
