Skip to content

Commit

Permalink
docs: Improve wording
Browse files Browse the repository at this point in the history
Co-authored-by: Mark Sellings <[email protected]>
  • Loading branch information
saig0 and mesellings authored Sep 5, 2024
1 parent 4b660bd commit ac2c144
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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**
Expand Down Expand Up @@ -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**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,11 @@ 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

Adds a value to another value. The operator is defined for the followings types.
Adds a value to another value. The operator is defined for the following types.

If a value has a different type, the result is `null`.

Expand Down

0 comments on commit ac2c144

Please sign in to comment.