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

Remove redundant aggregate/window/scalar function documentation #12745

Merged
merged 4 commits into from
Oct 8, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 3, 2024

Which issue does this PR close?

Part of #12740

Rationale for this change

@Omega359 has created the basic framework for automatically generating content in #12668

There will be a period of transition as we migrate the existing content to the new code style

We should make it it clearer what functions and documentation remain to port during this transition period by ensuring there is no duplicated content

#12743 makes it clearer how to find other documentation

What changes are included in this PR?

Remove the static function definitions for all functions that are now auto generated (I will comment inline)

Are these changes tested?

I manually built the docs

Are there any user-facing changes?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 3, 2024
@@ -56,45 +53,6 @@ avg(expression)

- `mean`

### `bit_and`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -339,23 +338,6 @@ ln(numeric_expression)
- **numeric_expression**: Numeric expression to operate on.
Can be a constant, column, or function, and any combination of arithmetic operators.

### `log`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

- [nullif](#nullif)
- [nvl](#nvl)
- [nvl2](#nvl2)
- [ifnull](#ifnull)

### `coalesce`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -644,7 +608,6 @@ _Alias of [nvl](#nvl)._

## String Functions

- [ascii](#ascii)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -665,7 +628,6 @@ _Alias of [nvl](#nvl)._
- [replace](#replace)
- [reverse](#reverse)
- [right](#right)
- [rpad](#rpad)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -1257,102 +1183,18 @@ find_in_set(str, strlist)
- **str**: String expression to find in strlist.
- **strlist**: A string list is a string composed of substrings separated by , characters.

## Binary String Functions
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -1727,49 +1568,6 @@ Additional examples can be found [here]

- date_format

### `to_date`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -3889,19 +3686,6 @@ md5(expression)

#### Arguments

- **expression**: String expression to operate on.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

- [rank](#rank)
- [dense_rank](#dense_rank)
- [ntile](#ntile)

### `row_number`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@alamb alamb marked this pull request as ready for review October 3, 2024 18:01
Copy link
Contributor

@jayzhan211 jayzhan211 left a comment

Choose a reason for hiding this comment

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

👍

@alamb
Copy link
Contributor Author

alamb commented Oct 8, 2024

Thank you for the review @jayzhan211

@alamb alamb merged commit 7d36059 into apache:main Oct 8, 2024
5 checks passed
@alamb alamb deleted the alamb/remove_redundant_docs branch October 8, 2024 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants