This is an automated email from the ASF dual-hosted git repository.
jgemignani pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/age-website.git
The following commit(s) were added to refs/heads/master by this push:
new 5cf7cea5 Revise Contributing and Functions Documentation (#242)
5cf7cea5 is described below
commit 5cf7cea54d9908990f615e8feef16e23ab04e986
Author: Dehowe Feng <[email protected]>
AuthorDate: Thu Dec 21 09:24:35 2023 +0800
Revise Contributing and Functions Documentation (#242)
Edits the documentation for capitalization, grammar, content and
other imrprovements.
---
docs/contributing/run_tests.md | 2 +-
docs/functions/aggregate_functions.md | 14 +++++++-------
docs/functions/list_functions.md | 16 ++++++++--------
docs/functions/logarithmic_functions.md | 6 +++---
docs/functions/map_functions.md | 2 +-
docs/functions/numeric_functions.md | 8 ++++----
docs/functions/scalar_functions.md | 19 ++++++++++++-------
docs/functions/string_functions.md | 22 +++++++++++-----------
docs/functions/trigonometric_functions.md | 20 ++++++++++----------
docs/functions/user_functions.md | 2 +-
10 files changed, 58 insertions(+), 53 deletions(-)
diff --git a/docs/contributing/run_tests.md b/docs/contributing/run_tests.md
index 92b967c4..98b6d4a1 100644
--- a/docs/contributing/run_tests.md
+++ b/docs/contributing/run_tests.md
@@ -1,6 +1,6 @@
# Run the test suite
-The configuration for running the tests is included in `Makefile`. Only
running the tests against an existing installation is supported:
+The configuration for running the tests is included in `Makefile`. The tests
will be run against an existing installation:
```console
make -j$(nproc)
diff --git a/docs/functions/aggregate_functions.md
b/docs/functions/aggregate_functions.md
index a98fa16c..5d568eb5 100644
--- a/docs/functions/aggregate_functions.md
+++ b/docs/functions/aggregate_functions.md
@@ -240,7 +240,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -314,7 +314,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -388,7 +388,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -468,7 +468,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -553,7 +553,7 @@ Returns:
```
-An agtype Integer.
+An agtype integer.
```
@@ -777,7 +777,7 @@ Returns:
```
-An agtype Integer
+An agtype integer
```
@@ -851,7 +851,7 @@ Returns:
```
-An agtype Float
+An agtype float
```
diff --git a/docs/functions/list_functions.md b/docs/functions/list_functions.md
index a1f6ef75..5d7d8828 100644
--- a/docs/functions/list_functions.md
+++ b/docs/functions/list_functions.md
@@ -19,13 +19,13 @@ $$) as (result agtype);
## keys
-keys returns a list containing the string representations for all the property
names of a vertex, edge, or map.
+`keys()` returns a list containing the string representations for all the
property names of a vertex, edge, or map.
Syntax: `keys(expression)`
Returns:
```
-An Agtype list containing string agtype elements
+An agtype list containing string agtype elements
```
Arguments:
@@ -83,7 +83,7 @@ Syntax: `range(start, end [, step])`
Returns:
```
-An Agtype list containing integer elements
+An agtype list containing integer elements
```
Arguments:
@@ -150,7 +150,7 @@ Syntax: `labels(vertex)`
Returns:
```
-An Agtype list containing String elements
+An agtype list containing string elements
```
Arguments:
@@ -208,7 +208,7 @@ Syntax: `nodes(path)`
Returns:
```
-An Agtype list containing vertex entities
+An agtype list containing vertex entities
```
Arguments:
@@ -222,7 +222,7 @@ Arguments:
<tr>
<td>path
</td>
- <td>An expression that returns an Agtype path.
+ <td>An expression that returns an agtype path.
</td>
</tr>
</table>
@@ -266,7 +266,7 @@ Syntax: `relationships(path)`
Returns:
```
-An Agtype list containing edge entities
+An agtype list containing edge entities
```
Arguments:
@@ -280,7 +280,7 @@ Arguments:
<tr>
<td>path
</td>
- <td>An expression that returns an Agtype path.
+ <td>An expression that returns an agtype path.
</td>
</tr>
</table>
diff --git a/docs/functions/logarithmic_functions.md
b/docs/functions/logarithmic_functions.md
index e02542b1..9ea31b92 100644
--- a/docs/functions/logarithmic_functions.md
+++ b/docs/functions/logarithmic_functions.md
@@ -101,7 +101,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -173,7 +173,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -246,7 +246,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
diff --git a/docs/functions/map_functions.md b/docs/functions/map_functions.md
index 3074de24..ecc8614a 100644
--- a/docs/functions/map_functions.md
+++ b/docs/functions/map_functions.md
@@ -1,6 +1,6 @@
# Map Functions
-In AGE, a map is a data structure that allows you to store a collection of
key-value pairs. Each key within a map is unique, and it is associated with a
corresponding value.
+In AGE, a map is a data structure that allows you to store a collection of
key-value pairs. Each key within a map is unique, and is associated with a
corresponding value.
This data structure is similar to dictionaries in Python or objects in
JavaScript, providing an efficient way to organize and retrieve data based on
keys.
This section focuses on explaining various functions that allow you to
generate and manipulate maps effectively.
diff --git a/docs/functions/numeric_functions.md
b/docs/functions/numeric_functions.md
index 42815869..dbfc52a2 100644
--- a/docs/functions/numeric_functions.md
+++ b/docs/functions/numeric_functions.md
@@ -11,7 +11,7 @@ Returns:
```
-A Float.
+A float.
```
@@ -140,7 +140,7 @@ Returns:
```
-A Float.
+A float.
```
@@ -212,7 +212,7 @@ Returns:
```
-A Float.
+A float.
```
@@ -286,7 +286,7 @@ Returns:
```
-A Float.
+A float.
```
diff --git a/docs/functions/scalar_functions.md
b/docs/functions/scalar_functions.md
index 7ee5babf..32a63c3c 100644
--- a/docs/functions/scalar_functions.md
+++ b/docs/functions/scalar_functions.md
@@ -317,7 +317,7 @@ Returns:
```
-An agtype Map.
+An agtype map.
```
@@ -542,7 +542,7 @@ Returns:
```
-An agtype Integer.
+An agtype integer.
```
@@ -620,7 +620,7 @@ Returns:
```
-An agtype Integer.
+An agtype integer.
```
@@ -842,7 +842,7 @@ Returns:
```
-An Agtype Integer.
+An agtype integer.
```
@@ -895,7 +895,7 @@ Returns:
```
-An agtype Boolean.
+An agtype boolean.
```
@@ -967,7 +967,12 @@ Result:
Syntax: `toFloat(expression)`
-Returns:A Float.
+Returns:
+
+
+```
+A float.
+```
<table>
@@ -1039,7 +1044,7 @@ Returns:
```
-An agtype Integer.
+An agtype integer.
```
diff --git a/docs/functions/string_functions.md
b/docs/functions/string_functions.md
index 121ef406..a0b565cd 100644
--- a/docs/functions/string_functions.md
+++ b/docs/functions/string_functions.md
@@ -11,7 +11,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -177,7 +177,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -256,7 +256,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -335,7 +335,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -426,7 +426,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -496,7 +496,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -566,7 +566,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -636,7 +636,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -706,7 +706,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -776,7 +776,7 @@ Returns:
```
-An agtype String.
+An agtype string.
```
@@ -846,7 +846,7 @@ Returns:
```
-A String.
+A string.
```
diff --git a/docs/functions/trigonometric_functions.md
b/docs/functions/trigonometric_functions.md
index 7beb00a2..ed643359 100644
--- a/docs/functions/trigonometric_functions.md
+++ b/docs/functions/trigonometric_functions.md
@@ -11,7 +11,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -83,7 +83,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -202,7 +202,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -274,7 +274,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -346,7 +346,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -418,7 +418,7 @@ Returns:
```
-A Float.
+A float.
```
@@ -490,7 +490,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -563,7 +563,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -636,7 +636,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
@@ -708,7 +708,7 @@ Returns:
```
-An agtype Float.
+An agtype float.
```
diff --git a/docs/functions/user_functions.md b/docs/functions/user_functions.md
index 94e884f8..4d9b05a2 100644
--- a/docs/functions/user_functions.md
+++ b/docs/functions/user_functions.md
@@ -1,6 +1,6 @@
# User Defined Functions
-Users may add custom functions to the AGE. When using the Cypher function, all
function calls with a Cypher query use the default namespace of: `ag_catalog`.
However if a user want to use a function outside this namespace, they may do so
by adding the namespace before the function name.
+Users may add custom functions to AGE. When using Cypher functions, all
function calls with a Cypher query use the default namespace of: `ag_catalog`.
However if a user wants to use a function outside of this namespace, they may
do so by adding the namespace before the function name.
Syntax: `namespace_name.function_name`
