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

doc-gen: migrate scalar functions (string) documentation 2/4 #13925

Merged

Conversation

Chen-Yuan-Lai
Copy link
Contributor

@Chen-Yuan-Lai Chen-Yuan-Lai commented Dec 27, 2024

Which issue does this PR close?

Part of #13671 .

Rationale for this change

What changes are included in this PR?

As discussed in #13671 , this PR will migrate the parts of builtin string functions documentation that currently support migration.

Are these changes tested?

Are there any user-facing changes?

@Omega359
Copy link
Contributor

Did you run the doc generation script prior to pushing this change? The doc diff seems ... odd

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 29, 2024
@@ -1697,8 +1697,8 @@ upper(str)

**Related functions**:

- [initcap](#initcap)
- [lower](#lower)
Copy link
Contributor

Choose a reason for hiding this comment

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

hm, why we have this change? 🤔 its not critical but last revision was better as it sorted

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I overlooked the sorting part. You're right. I'll revert it back. Thanks for catching this! 👍

@@ -971,8 +971,8 @@ concat_ws(separator, str[, ..., str_n])

#### Arguments

- **separator**: Separator to insert between concatenated strings.
- **str**: String expression to operate on. Can be a constant, column, or function, and any combination of operators.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think separator should come first in order like it is in the function signature

Copy link
Contributor Author

@Chen-Yuan-Lai Chen-Yuan-Lai Dec 31, 2024

Choose a reason for hiding this comment

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

I tried changing the order between argument and standard argument in user_doc(), but the documentation order didn't change. Is the order of content sections fixed?

Copy link
Contributor

Choose a reason for hiding this comment

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

I will check that

Copy link
Contributor

Choose a reason for hiding this comment

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

The problem is the mixed argument and standard_argument and then again argument. Pretty rare edge case

@comphead
Copy link
Contributor

comphead commented Jan 2, 2025

@Chen-Yuan-Lai please take latest updates from your branch and run ./dev/update_function_docs.sh I think this way we fixing all the mismatches

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jan 3, 2025
@Chen-Yuan-Lai Chen-Yuan-Lai force-pushed the migrate_scalar_functions_string_2/4 branch from 214bbe3 to 8c037ad Compare January 3, 2025 02:56
Copy link
Contributor

@crepererum crepererum left a comment

Choose a reason for hiding this comment

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

thank you

@crepererum crepererum merged commit e59045d into apache:main Jan 3, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants