Skip to content

Commit

Permalink
Align return value description terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Jan 4, 2021
1 parent 69d8552 commit 7e0e949
Show file tree
Hide file tree
Showing 31 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion aggregate_spatial.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion aggregate_temporal.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion aggregate_temporal_period.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion apply.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion apply_dimension.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion apply_neighborhood.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
}
],
"returns": {
"description": "Return the data cube with the newly computed values and the same dimensions. The dimension properties (name, type, labels, reference system and resolution) must remain unchanged, otherwise a `DataCubePropertiesImmutable` exception will be thrown.",
"description": "The data cube with the newly computed values and the same dimensions. The dimension properties (name, type, labels, reference system and resolution) must remain unchanged, otherwise a `DataCubePropertiesImmutable` exception will be thrown.",
"schema": {
"type": "object",
"subtype": "raster-cube"
Expand Down
2 changes: 1 addition & 1 deletion array_apply.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the array.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion array_contains.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
}
],
"returns": {
"description": "Returns `true` if the list contains the value, false` otherwise.",
"description": "`true` if the list contains the value, false` otherwise.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion array_element.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "array_element",
"summary": "Get an element from an array",
"description": "Returns the element with the specified index or label from the array.\n\nEither the parameter `index` or `label` must be specified, otherwise the `ArrayElementParameterMissing` exception is thrown. If both parameters are set the `ArrayElementParameterConflict` exception is thrown.",
"description": "Gives the element with the specified index or label from the array.\n\nEither the parameter `index` or `label` must be specified, otherwise the `ArrayElementParameterMissing` exception is thrown. If both parameters are set the `ArrayElementParameterConflict` exception is thrown.",
"categories": [
"arrays",
"reducer"
Expand Down
2 changes: 1 addition & 1 deletion array_filter.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
}
],
"returns": {
"description": "Return `true` if the value should be kept in the array, otherwise return `false`.",
"description": "`true` if the value should be kept in the array, otherwise `false`.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion array_find.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
}
],
"returns": {
"description": "Returns the index of the first element with the specified value. If no element was found, `null` is returned.",
"description": "The index of the first element with the specified value. If no element was found, `null` is a.",
"schema": [
{
"type": "null"
Expand Down
2 changes: 1 addition & 1 deletion array_labels.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "array_labels",
"summary": "Get the labels for an array",
"description": "Returns all labels for a labeled array in the data cube. The labels have the same order as in the array.",
"description": "Gives all labels for a labeled array in the data cube. The labels have the same order as in the array.",
"categories": [
"arrays"
],
Expand Down
2 changes: 1 addition & 1 deletion count.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
}
],
"returns": {
"description": "Return `true` if the element should increase the counter, otherwise return `false`.",
"description": "`true` if the element should increase the counter, otherwise `false`.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion debug.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
}
],
"returns": {
"description": "Returns the data as passed to the `data` parameter.",
"description": "The data as passed to the `data` parameter without any modification.",
"schema": {
"description": "Any data type is allowed."
}
Expand Down
2 changes: 1 addition & 1 deletion dimension_labels.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "dimension_labels",
"summary": "Get the dimension labels",
"description": "Returns all labels for a dimension in the data cube. The labels have the same order as in the data cube.",
"description": "Gives all labels for a dimension in the data cube. The labels have the same order as in the data cube.",
"categories": [
"cubes"
],
Expand Down
2 changes: 1 addition & 1 deletion eq.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
],
"returns": {
"description": "Returns `true` if `x` is equal to `y`, `null` if any operand is `null`, otherwise `false`.",
"description": "`true` if `x` is equal to `y`, `null` if any operand is `null`, otherwise `false`.",
"schema": {
"type": [
"boolean",
Expand Down
2 changes: 1 addition & 1 deletion examples/array_contains_nodata.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
}
],
"returns": {
"description": "Returns `true` if the list contains a no-data value, false` otherwise.",
"description": "`true` if the list contains a no-data value, false` otherwise.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion examples/array_find_nodata.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
}
],
"returns": {
"description": "Returns the index of the first element with a no-data value. If only data values are available, `null` is returned.",
"description": "The index of the first element with a no-data value. If only data values are available, `null` is returned.",
"schema": [
{
"type": "null"
Expand Down
2 changes: 1 addition & 1 deletion filter_labels.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
}
],
"returns": {
"description": "Return `true` if the dimension label should be kept in the data cube, otherwise return `false`.",
"description": "`true` if the dimension label should be kept in the data cube, otherwise `false`.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion load_collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
}
],
"returns": {
"description": "Return `true` if the data should be loaded into the data cube, otherwise return `false`.",
"description": "`true` if the data should be loaded into the data cube, otherwise `false`.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion merge_cubes.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion meta/subtype-schemas.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@
}
],
"returns": {
"description": "Return `true` if the data should be used, otherwise return `false`.",
"description": "`true` if the data should be used, otherwise `false`.",
"schema": {
"type": "boolean"
}
Expand Down
2 changes: 1 addition & 1 deletion neq.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
],
"returns": {
"description": "Returns `true` if `x` is *not* equal to `y`, `null` if any operand is `null`, otherwise `false`.",
"description": "`true` if `x` is *not* equal to `y`, `null` if any operand is `null`, otherwise `false`.",
"schema": {
"type": [
"boolean",
Expand Down
2 changes: 1 addition & 1 deletion proposals/aggregate_spatial_binary.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion proposals/aggregate_spatial_window.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion proposals/reduce_dimension_binary.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion proposals/run_udf_externally.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
},
{
"name": "context",
"description": "Additional data such as configuration options that should be passed to the UDF.",
"description": "Additional data such as configuration options to be passed to the UDF.",
"schema": {
"type": "object"
},
Expand Down
2 changes: 1 addition & 1 deletion reduce_dimension.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion resample_cube_temporal.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
}
],
"returns": {
"description": "Return the value that should be stored in the data cube.",
"description": "The value to be stored in the data cube.",
"schema": {
"description": "Any data type."
}
Expand Down
2 changes: 1 addition & 1 deletion run_udf.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
},
{
"name": "context",
"description": "Additional data such as configuration options that should be passed to the UDF.",
"description": "Additional data such as configuration options to be passed to the UDF.",
"schema": {
"type": "object"
},
Expand Down
2 changes: 1 addition & 1 deletion text_merge.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
}
],
"returns": {
"description": "Returns a string containing a string representation of all the array elements in the same order, with the separator between each element.",
"description": "A string containing a string representation of all the array elements in the same order, with the separator between each element.",
"schema": {
"type": "string"
}
Expand Down

0 comments on commit 7e0e949

Please sign in to comment.