Skip to content

fix: correct the copy-pasted docs for covar_pop and bool_or #24990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackylee-ch wants to merge 1 commit into from
+18 −18
Open

fix: correct the copy-pasted docs for covar_pop and bool_or #24990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions datafusion/functions-aggregate/src/bool_and_or.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,12 +221,12 @@ impl Accumulator for BoolAndAccumulator {

#[user_doc(
doc_section(label = "General Functions"),
description = "Returns true if all non-null input values are true, otherwise false.",
syntax_example = "bool_and(expression)",
description = "Returns true if any non-null input value is true, otherwise false.",
syntax_example = "bool_or(expression)",
sql_example = r#"```sql
> SELECT bool_and(column_name) FROM table_name;
> SELECT bool_or(column_name) FROM table_name;
+----------------------------+
| bool_and(column_name) |
| bool_or(column_name) |
+----------------------------+
| true |
+----------------------------+
Expand Down
10 changes: 5 additions & 5 deletions datafusion/functions-aggregate/src/covariance.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ impl AggregateUDFImpl for CovarianceSample {

#[user_doc(
doc_section(label = "Statistical Functions"),
description = "Returns the sample covariance of a set of number pairs.",
syntax_example = "covar_samp(expression1, expression2)",
description = "Returns the population covariance of a set of number pairs.",
syntax_example = "covar_pop(expression1, expression2)",
sql_example = r#"```sql
> SELECT covar_samp(column1, column2) FROM table_name;
> SELECT covar_pop(column1, column2) FROM table_name;
+-----------------------------------+
| covar_samp(column1, column2) |
| covar_pop(column1, column2) |
+-----------------------------------+
| 8.25 |
| 7.63333333333 |
+-----------------------------------+
```"#,
standard_argument(name = "expression1", prefix = "First"),
Expand Down
18 changes: 9 additions & 9 deletions docs/source/user-guide/sql/aggregate_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,10 @@ bool_and(expression)

### `bool_or`

Returns true if all non-null input values are true, otherwise false.
Returns true if any non-null input value is true, otherwise false.

```sql
bool_and(expression)
bool_or(expression)
```

#### Arguments
Expand All @@ -260,9 +260,9 @@ bool_and(expression)
#### Example

```sql
> SELECT bool_and(column_name) FROM table_name;
> SELECT bool_or(column_name) FROM table_name;
+----------------------------+
| bool_and(column_name) |
| bool_or(column_name) |
+----------------------------+
| true |
+----------------------------+
Expand Down Expand Up @@ -644,10 +644,10 @@ _Alias of [covar_samp](#covar_samp)._

### `covar_pop`

Returns the sample covariance of a set of number pairs.
Returns the population covariance of a set of number pairs.

```sql
covar_samp(expression1, expression2)
covar_pop(expression1, expression2)
```

#### Arguments
Expand All @@ -658,11 +658,11 @@ covar_samp(expression1, expression2)
#### Example

```sql
> SELECT covar_samp(column1, column2) FROM table_name;
> SELECT covar_pop(column1, column2) FROM table_name;
+-----------------------------------+
| covar_samp(column1, column2) |
| covar_pop(column1, column2) |
+-----------------------------------+
| 8.25 |
| 7.63333333333 |
+-----------------------------------+
```

Expand Down