Update CypherTypes in procedure/function descriptions (#678)

We are updating the descriptions in the output for SHOW FUNCTIONS and SHOW PROCEDURES to match the defaults of the new Cypher Types
neo4j · Sep 6, 2023 · ce5d0cd · ce5d0cd
1 parent 99df52d
commit ce5d0cd
Show file tree

Hide file tree

Showing 30 changed files with 872 additions and 872 deletions.
diff --git a/modules/ROOT/pages/administration/access-control/manage-privileges.adoc b/modules/ROOT/pages/administration/access-control/manage-privileges.adoc
@@ -250,7 +250,7 @@ Results will include multiple columns describing the privileges:
 
 | scope
 | List of possible scopes for the privilege (`elements`, `nodes`, `relationships`) or null if not applicable.
-| LIST OF STRING
+| LIST<STRING>
 
 | description
 | A short description of the privilege.

diff --git a/modules/ROOT/pages/administration/access-control/manage-users.adoc b/modules/ROOT/pages/administration/access-control/manage-users.adoc
@@ -364,7 +364,7 @@ The currently logged-in user can be seen using `SHOW CURRENT USER`, which will p
 | Roles granted to the user.
 
 Will return `null` in community edition.
-| LIST OF STRING
+| LIST<STRING>
 | {cross-mark}
 | {check-mark}
 
@@ -444,7 +444,7 @@ Available users can be seen using `SHOW USERS`, which will produce a table of us
 | Roles granted to the user.
 
 Will return `null` in community edition.
-| LIST OF STRING
+| LIST<STRING>
 | {cross-mark}
 | {check-mark}
 

diff --git a/modules/ROOT/pages/administration/databases.adoc b/modules/ROOT/pages/administration/databases.adoc
@@ -146,7 +146,7 @@ These commands return the following columns:
 
 | aliases
 | The names of any aliases the database may have. label:default-output[]
-| LIST OF STRING
+| LIST<STRING>
 
 | access
 | The database access mode, either `read-write` or `read-only`. label:default-output[]
@@ -279,7 +279,7 @@ The lag is expressed in negative integers. In standalone environments, the value
 
 |constituents
 |The names of any constituents the database may have. label:default-output[]
-| LIST OF STRING
+| LIST<STRING>
 
 |===
 

diff --git a/modules/ROOT/pages/administration/servers.adoc b/modules/ROOT/pages/administration/servers.adoc
@@ -232,32 +232,32 @@ The table of results shows information about the servers:
 
 | hosting
 | A list of databases currently hosted on the server.
-| LIST OF STRING
+| LIST<STRING>
 | {check-mark}
 | {check-mark}
 
 | requestedHosting
 | A list of databases that should be hosted on the server.
 Composite databases do not currently appear in this list, though they do appear in `hosting` for all servers.
-| LIST OF STRING
+| LIST<STRING>
 |
 | {check-mark}
 
 | tags
 | Tags are user provided strings that can be used while allocating databases.
-| LIST OF STRING
+| LIST<STRING>
 |
 | {check-mark}
 
 | allowedDatabases
 | A list of databases allowed to be hosted on the server.
-| LIST OF STRING
+| LIST<STRING>
 |
 | {check-mark}
 
 | deniedDatabases
 | A list of databases not allowed to be hosted on the server.
-| LIST OF STRING
+| LIST<STRING>
 |
 | {check-mark}
 

diff --git a/modules/ROOT/pages/clauses/listing-functions.adoc b/modules/ROOT/pages/clauses/listing-functions.adoc
@@ -47,7 +47,7 @@ m| BOOLEAN
 
 m| argumentDescription
 a| List of the arguments for the function, as map of strings and booleans with `name`, `type`, `default`, `isDeprecated`, and `description`.
-m| LIST OF MAP
+m| LIST<MAP>
 
 m| returnDescription
 a| The return value type.
@@ -61,13 +61,13 @@ m| rolesExecution
 a|
 List of roles permitted to execute this function.
 Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege.
-m| LIST OF STRING
+m| LIST<STRING>
 
 m| rolesBoostedExecution
 a|
 List of roles permitted to use boosted mode when executing this function.
 Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege.
-m| LIST OF STRING
+m| LIST<STRING>
 
 m| isDeprecated
 a| Whether the function is deprecated.
@@ -151,51 +151,51 @@ SHOW FUNCTIONS
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of an integer."
+| "Returns the absolute value of an `INTEGER`."
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of a floating point number."
+| "Returns the absolute value of a `FLOAT`."
 
 | "acos"
 | "Trigonometric"
-| "Returns the arccosine of a number in radians."
+| "Returns the arccosine of a `FLOAT` in radians."
 
 | "all"
 | "Predicate"
-| "Returns true if the predicate holds for all elements in the given list."
+| "Returns true if the predicate holds for all elements in the given `LIST<ANY>`."
 
 | "any"
 | "Predicate"
-| "Returns true if the predicate holds for at least one element in the given list."
+| "Returns true if the predicate holds for at least one element in the given `LIST<ANY>`."
 
 | "asin"
 | "Trigonometric"
-| "Returns the arcsine of a number in radians."
+| "Returns the arcsine of a `FLOAT` in radians."
 
 | "atan"
 | "Trigonometric"
-| "Returns the arctangent of a number in radians."
+| "Returns the arctangent of a `FLOAT` in radians."
 
 | "atan2"
 | "Trigonometric"
 | "Returns the arctangent2 of a set of coordinates in radians."
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of integer values."
+| "Returns the average of a set of `INTEGER` values."
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of floating point values."
+| "Returns the average of a set of `FLOAT` values."
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of duration values."
+| "Returns the average of a set of `DURATION` values."
 
 | "ceil"
 | "Numeric"
-| "Returns the smallest floating point number that is greater than or equal to a number and equal to a mathematical integer."
+| "Returns the smallest `FLOAT` that is greater than or equal to a number and equal to an `INTEGER`."
 
 | "coalesce"
 | "Scalar"
@@ -207,27 +207,27 @@ SHOW FUNCTIONS
 
 | "cos"
 | "Trigonometric"
-| "Returns the cosine  of a number."
+| "Returns the cosine of a `FLOAT`."
 
 | "cot"
 | "Trigonometric"
-| "Returns the cotangent of a number."
+| "Returns the cotangent of a `FLOAT`."
 
 | "count"
 | "Aggregating"
 | "Returns the number of values or rows."
 
 | "date"
 | "Temporal"
-| "Create a Date instant."
+| "Creates a `DATE` instant."
 
 | "date.realtime"
 | "Temporal"
-| "Get the current Date instant using the realtime clock."
+| "Returns the current `DATE` instant using the realtime clock."
 
 | "date.statement"
 | "Temporal"
-| "Get the current Date instant using the statement clock."
+| "Returns the current `DATE` instant using the statement clock."
 
 3+d|Rows: 20
 |===
@@ -292,49 +292,49 @@ SHOW FUNCTIONS EXECUTABLE BY CURRENT USER YIELD *
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of an integer."
+| "Returns the absolute value of an `INTEGER`."
 | <null>
 | <null>
 |
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of a floating point number."
+| "Returns the absolute value of a `FLOAT`."
 | <null>
 | <null>
 |
 
 | "acos"
 | "Trigonometric"
-| "Returns the arccosine of a number in radians."
+| "Returns the arccosine of a `FLOAT` in radians."
 | <null>
 | <null>
 |
 
 | "all"
 | "Predicate"
-| "Returns true if the predicate holds for all elements in the given list."
+| "Returns true if the predicate holds for all elements in the given `LIST<ANY>`."
 | <null>
 | <null>
 |
 
 | "any"
 | "Predicate"
-| "Returns true if the predicate holds for at least one element in the given list."
+| "Returns true if the predicate holds for at least one element in the given `LIST<ANY>`."
 | <null>
 | <null>
 |
 
 | "asin"
 | "Trigonometric"
-| "Returns the arcsine of a number in radians."
+| "Returns the arcsine of a `FLOAT` in radians."
 | <null>
 | <null>
 |
 
 | "atan"
 | "Trigonometric"
-| "Returns the arctangent of a number in radians."
+| "Returns the arctangent of a `FLOAT` in radians."
 | <null>
 | <null>
 |
@@ -348,14 +348,14 @@ SHOW FUNCTIONS EXECUTABLE BY CURRENT USER YIELD *
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of integer values."
+| "Returns the average of a set of `INTEGER` values."
 | <null>
 | <null>
 |
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of floating point values."
+| "Returns the average of a set of `FLOAT` values."
 | <null>
 | <null>
 |
@@ -388,43 +388,43 @@ SHOW FUNCTIONS EXECUTABLE BY jake
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of an integer."
+| "Returns the absolute value of an `INTEGER`."
 
 | "abs"
 | "Numeric"
-| "Returns the absolute value of a floating point number."
+| "Returns the absolute value of a `FLOAT`."
 
 | "acos"
 | "Trigonometric"
-| "Returns the arccosine of a number in radians."
+| "Returns the arccosine of a `FLOAT` in radians."
 
 | "all"
 | "Predicate"
-| "Returns true if the predicate holds for all elements in the given list."
+| "Returns true if the predicate holds for all elements in the given `LIST<ANY>`."
 
 | "any"
 | "Predicate"
-| "Returns true if the predicate holds for at least one element in the given list."
+| "Returns true if the predicate holds for at least one element in the given `LIST<ANY>`."
 
 | "asin"
 | "Trigonometric"
-| "Returns the arcsine of a number in radians."
+| "Returns the arcsine of a `FLOAT` in radians."
 
 | "atan"
 | "Trigonometric"
-| "Returns the arctangent of a number in radians."
+| "Returns the arctangent of a `FLOAT` in radians."
 
 | "atan2"
 | "Trigonometric"
 | "Returns the arctangent2 of a set of coordinates in radians."
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of integer values."
+| "Returns the average of a set of `INTEGER` values."
 
 | "avg"
 | "Aggregating"
-| "Returns the average of a set of floating point values."
+| "Returns the average of a set of `FLOAT` values."
 
 3+d|Rows: 10
 |===
diff --git a/modules/ROOT/pages/clauses/listing-procedures.adoc b/modules/ROOT/pages/clauses/listing-procedures.adoc
@@ -45,11 +45,11 @@ m| STRING
 
 m| argumentDescription
 a| List of the arguments for the procedure, as map of strings and booleans with `name`, `type`, `default`, `isDeprecated`, and `description`.
-m| LIST OF MAP
+m| LIST<MAP>
 
 m| returnDescription
 a| List of the returned values for the procedure, as map of strings and booleans with `name`, `type`, `isDeprecated`, and `description`.
-m| LIST OF MAP
+m| LIST<MAP>
 
 m| admin
 a| `true` if this procedure is an admin procedure.
@@ -59,13 +59,13 @@ m| rolesExecution
 a|
 List of roles permitted to execute this procedure.
 Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege.
-m| LIST OF STRING
+m| LIST<STRING>
 
 m| rolesBoostedExecution
 a|
 List of roles permitted to use boosted mode when executing this procedure.
 Is `null` without the xref::administration/access-control/dbms-administration.adoc#access-control-dbms-administration-role-management[`SHOW ROLE`] privilege.
-m| LIST OF STRING
+m| LIST<STRING>
 
 m| isDeprecated
 a| Whether the procedure is deprecated.
@@ -259,7 +259,7 @@ WHERE admin
 | "db.stats.retrieveAllAnonymized" | true
 | "db.stats.status" | true
 | "db.stats.stop" | true
-| "dbms.checkConfigValue" | true+
+| "dbms.checkConfigValue" | true
 | "dbms.cluster.checkConnectivity" | true
 | "dbms.cluster.cordonServer" | true
 | "dbms.cluster.readReplicaToggle" | true

diff --git a/modules/ROOT/pages/clauses/set.adoc b/modules/ROOT/pages/clauses/set.adoc
@@ -151,7 +151,7 @@ SET n.age = toString(n.age)
 RETURN n.name, n.age
 ----
 
-The `age` property has been converted to the string `'36'`.
+The `age` property has been converted to the `STRING` `'36'`.
 
 .Result
 [role="queryresult",options="header,footer",cols="2*<m"]

diff --git a/modules/ROOT/pages/clauses/transaction-clauses.adoc b/modules/ROOT/pages/clauses/transaction-clauses.adoc
@@ -94,7 +94,7 @@ m| STRING
 
 m| indexes
 a| The indexes utilised by the query currently executing in this transaction, or an empty list if no query is currently executing.
-m| LIST OF MAP
+m| LIST<MAP>
 
 // New in 5.0
 m| currentQueryStartTime

diff --git a/modules/ROOT/pages/clauses/where.adoc b/modules/ROOT/pages/clauses/where.adoc
@@ -469,7 +469,7 @@ WHERE n.name =~ '(?i)AND.*'
 RETURN n.name, n.age
 ----
 
-The `name` and `age`` for `Andy` are returned because his name starts with 'AND' irrespective of casing:
+The `name` and `age` for `Andy` are returned because his name starts with 'AND' irrespective of casing:
 
 .Result
 [role="queryresult",options="header,footer",cols="2*<m"]