From 7034f0b221ce12b4fd7240fadb55569649ffdecb Mon Sep 17 00:00:00 2001 From: Philipp Ossler Date: Thu, 5 Sep 2024 11:21:32 +0200 Subject: [PATCH] docs: Improve wording --- .../builtin-functions/feel-built-in-functions-conversion.md | 6 +++--- .../builtin-functions/feel-built-in-functions-string.md | 2 +- .../feel/language-guide/feel-temporal-expressions.md | 3 +-- .../builtin-functions/feel-built-in-functions-conversion.md | 6 +++--- .../builtin-functions/feel-built-in-functions-string.md | 2 +- .../feel/language-guide/feel-temporal-expressions.md | 3 +-- .../builtin-functions/feel-built-in-functions-conversion.md | 6 +++--- .../builtin-functions/feel-built-in-functions-string.md | 2 +- .../feel/language-guide/feel-temporal-expressions.md | 3 +-- .../builtin-functions/feel-built-in-functions-conversion.md | 6 +++--- .../builtin-functions/feel-built-in-functions-string.md | 2 +- .../feel/language-guide/feel-temporal-expressions.md | 3 +-- 12 files changed, 20 insertions(+), 24 deletions(-) diff --git a/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md b/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md index a95727dbcbb..6522611d83e 100644 --- a/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md +++ b/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md @@ -74,7 +74,7 @@ context([{"key":"a", "value":1}, {"key":"b", "value":2}]) Returns a date from the given value. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31"` which is invalid because June has +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31"` is invalid because June has only 30 days. **Function signature** @@ -105,7 +105,7 @@ date(date and time("2012-12-25T11:00:00")) Returns a date from the given components. -Returns `null` if the components don't represent a valid calendar date, for example, `2024,6,31` which is invalid because +Returns `null` if the components don't represent a valid calendar date. For example, `2024,6,31` is invalid because June has only 30 days. **Function signature** @@ -187,7 +187,7 @@ time(14, 30, 0, duration("PT1H")) Parses the given string into a date and time. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31T10:00:00"` which is invalid because +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31T10:00:00"` is invalid because June has only 30 days. **Function signature** diff --git a/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md b/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md index 4ea20e7659d..59308327d04 100644 --- a/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md +++ b/versioned_docs/version-8.2/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md @@ -30,7 +30,7 @@ substring("foobar", -2) ## substring(string, start position, length) -Returns a substring of the given value starting at `start position` with the given `length`. If `length` is greater than +Returns a substring of the given value, starting at `start position` with the given `length`. If `length` is greater than the remaining characters of the value, it returns all characters from `start position` until the end. **Function signature** diff --git a/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-temporal-expressions.md b/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-temporal-expressions.md index f2c8e43650a..9d90e4bdbf9 100644 --- a/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-temporal-expressions.md +++ b/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-temporal-expressions.md @@ -40,8 +40,7 @@ duration("P3M") @"P3M" ``` -The value is `null` if a date or date and time literal doesn't represent a valid calendar date, for example, -`@"2024-06-31"` which is invalid because June has only 30 days. +The value is `null` if a date or date-time literal doesn't represent a valid calendar date. For example, `@"2024-06-31"` is invalid because June has only 30 days. ### Addition diff --git a/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md b/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md index a95727dbcbb..6522611d83e 100644 --- a/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md +++ b/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md @@ -74,7 +74,7 @@ context([{"key":"a", "value":1}, {"key":"b", "value":2}]) Returns a date from the given value. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31"` which is invalid because June has +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31"` is invalid because June has only 30 days. **Function signature** @@ -105,7 +105,7 @@ date(date and time("2012-12-25T11:00:00")) Returns a date from the given components. -Returns `null` if the components don't represent a valid calendar date, for example, `2024,6,31` which is invalid because +Returns `null` if the components don't represent a valid calendar date. For example, `2024,6,31` is invalid because June has only 30 days. **Function signature** @@ -187,7 +187,7 @@ time(14, 30, 0, duration("PT1H")) Parses the given string into a date and time. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31T10:00:00"` which is invalid because +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31T10:00:00"` is invalid because June has only 30 days. **Function signature** diff --git a/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md b/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md index 4ea20e7659d..59308327d04 100644 --- a/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md +++ b/versioned_docs/version-8.3/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md @@ -30,7 +30,7 @@ substring("foobar", -2) ## substring(string, start position, length) -Returns a substring of the given value starting at `start position` with the given `length`. If `length` is greater than +Returns a substring of the given value, starting at `start position` with the given `length`. If `length` is greater than the remaining characters of the value, it returns all characters from `start position` until the end. **Function signature** diff --git a/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-temporal-expressions.md b/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-temporal-expressions.md index accf49e3ac2..bf7ce7cc2b8 100644 --- a/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-temporal-expressions.md +++ b/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-temporal-expressions.md @@ -40,8 +40,7 @@ duration("P3M") @"P3M" ``` -The value is `null` if a date or date and time literal doesn't represent a valid calendar date, for example, -`@"2024-06-31"` which is invalid because June has only 30 days. +The value is `null` if a date or date-time literal doesn't represent a valid calendar date. For example, `@"2024-06-31"` is invalid because June has only 30 days. ### Addition diff --git a/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md b/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md index a95727dbcbb..6522611d83e 100644 --- a/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md +++ b/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md @@ -74,7 +74,7 @@ context([{"key":"a", "value":1}, {"key":"b", "value":2}]) Returns a date from the given value. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31"` which is invalid because June has +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31"` is invalid because June has only 30 days. **Function signature** @@ -105,7 +105,7 @@ date(date and time("2012-12-25T11:00:00")) Returns a date from the given components. -Returns `null` if the components don't represent a valid calendar date, for example, `2024,6,31` which is invalid because +Returns `null` if the components don't represent a valid calendar date. For example, `2024,6,31` is invalid because June has only 30 days. **Function signature** @@ -187,7 +187,7 @@ time(14, 30, 0, duration("PT1H")) Parses the given string into a date and time. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31T10:00:00"` which is invalid because +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31T10:00:00"` is invalid because June has only 30 days. **Function signature** diff --git a/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md b/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md index 4ea20e7659d..59308327d04 100644 --- a/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md +++ b/versioned_docs/version-8.4/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md @@ -30,7 +30,7 @@ substring("foobar", -2) ## substring(string, start position, length) -Returns a substring of the given value starting at `start position` with the given `length`. If `length` is greater than +Returns a substring of the given value, starting at `start position` with the given `length`. If `length` is greater than the remaining characters of the value, it returns all characters from `start position` until the end. **Function signature** diff --git a/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-temporal-expressions.md b/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-temporal-expressions.md index accf49e3ac2..bf7ce7cc2b8 100644 --- a/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-temporal-expressions.md +++ b/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-temporal-expressions.md @@ -40,8 +40,7 @@ duration("P3M") @"P3M" ``` -The value is `null` if a date or date and time literal doesn't represent a valid calendar date, for example, -`@"2024-06-31"` which is invalid because June has only 30 days. +The value is `null` if a date or date-time literal doesn't represent a valid calendar date. For example, `@"2024-06-31"` is invalid because June has only 30 days. ### Addition diff --git a/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md b/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md index a95727dbcbb..6522611d83e 100644 --- a/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md +++ b/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md @@ -74,7 +74,7 @@ context([{"key":"a", "value":1}, {"key":"b", "value":2}]) Returns a date from the given value. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31"` which is invalid because June has +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31"` is invalid because June has only 30 days. **Function signature** @@ -105,7 +105,7 @@ date(date and time("2012-12-25T11:00:00")) Returns a date from the given components. -Returns `null` if the components don't represent a valid calendar date, for example, `2024,6,31` which is invalid because +Returns `null` if the components don't represent a valid calendar date. For example, `2024,6,31` is invalid because June has only 30 days. **Function signature** @@ -187,7 +187,7 @@ time(14, 30, 0, duration("PT1H")) Parses the given string into a date and time. -Returns `null` if the string is not a valid calendar date, for example, `"2024-06-31T10:00:00"` which is invalid because +Returns `null` if the string is not a valid calendar date. For example, `"2024-06-31T10:00:00"` is invalid because June has only 30 days. **Function signature** diff --git a/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md b/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md index 4ea20e7659d..59308327d04 100644 --- a/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md +++ b/versioned_docs/version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md @@ -30,7 +30,7 @@ substring("foobar", -2) ## substring(string, start position, length) -Returns a substring of the given value starting at `start position` with the given `length`. If `length` is greater than +Returns a substring of the given value, starting at `start position` with the given `length`. If `length` is greater than the remaining characters of the value, it returns all characters from `start position` until the end. **Function signature** diff --git a/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-temporal-expressions.md b/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-temporal-expressions.md index accf49e3ac2..bf7ce7cc2b8 100644 --- a/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-temporal-expressions.md +++ b/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-temporal-expressions.md @@ -40,8 +40,7 @@ duration("P3M") @"P3M" ``` -The value is `null` if a date or date and time literal doesn't represent a valid calendar date, for example, -`@"2024-06-31"` which is invalid because June has only 30 days. +The value is `null` if a date or date-time literal doesn't represent a valid calendar date. For example, `@"2024-06-31"` is invalid because June has only 30 days. ### Addition