Skip to content
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.

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

DOCSUP-2955: documented the rankCorr function #16109

Merged

Conversation

annvsh
Copy link
Contributor

@annvsh annvsh commented Oct 17, 2020

I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=en

Changelog category:

@robot-clickhouse robot-clickhouse added the pr-documentation Documentation PRs for the specific code PR label Oct 17, 2020
@annvsh annvsh changed the title Anna shakhova docsup 2955 document aggr func DOCSUP-2955: documented the rankCorr function Oct 17, 2020

**Parameters**

- `x` — Floating-point number. [Float64](../../../sql-reference/data-types/float.md#float32-float64).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also it is possible to write something more informative in the description.


**Returned value(s)**

- Returns a floating-point number.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type we see below. What is it the returned value?

**Parameters**

- `x` — Floating-point number. [Float64](../../../sql-reference/data-types/float.md#float32-float64).
- `y` — Floating-point number. [Float64](../../../sql-reference/data-types/float.md#float32-float64).
Copy link
Contributor

@BayoNet BayoNet Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a more informative description for y.

@@ -0,0 +1,51 @@
## rankCorr {#agg_function-rankcorr}

The aggregate function which computes a rank correlation coefficient.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The aggregate function which computes a rank correlation coefficient.
Computes a rank correlation coefficient.


**Parameters**

- `x` — Arbitrary value. It can be of the [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `x` — Arbitrary value. It can be of the [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).
- `x` — Arbitrary value. [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).

**Parameters**

- `x` — Arbitrary value. It can be of the [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).
- `y` — Arbitrary value. It can be of the [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `y` — Arbitrary value. It can be of the [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).
- `y` — Arbitrary value. [Float32](../../../sql-reference/data-types/float.md#float32-float64) or [Float64](../../../sql-reference/data-types/float.md#float32-float64).

@BayoNet BayoNet merged commit 0ae690e into ClickHouse:master Nov 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-documentation Documentation PRs for the specific code PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants