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 1/4 #13924

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

I believe you may have forgotten to run the doc generation script prior to pushing this change

@Chen-Yuan-Lai
Copy link
Contributor Author

Chen-Yuan-Lai commented Dec 28, 2024

@Omega359 Yes 😢 I'll run doc generation script for other PRs all together. Thanks for reviewing 🙏

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 29, 2024
Comment on lines 855 to 861
```sql
trim(trim_str FROM str)
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@comphead I found that use_doc() only supports one alternative syntax. Should we modify it to support multiple alternative syntaxes?

Copy link
Contributor

Choose a reason for hiding this comment

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

oh its a vec, yeah we should do it, as well as simplify a little bit the Documentation structure to replace Option<Vec> to just Vec

Copy link
Contributor

Choose a reason for hiding this comment

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

Lets leave trim not migrated for now and we can do it once the doc macros fixed

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I remove the change for trim() in this PR, thanks! I'd like to update use_doc() and migrate trim() simultaneously

@Chen-Yuan-Lai Chen-Yuan-Lai force-pushed the migrate_scalar_functions_string_1/4 branch from dcda1b8 to bd8033e Compare December 30, 2024 13:26
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Dec 30, 2024
Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

thanks @Chen-Yuan-Lai lgtm

@comphead comphead merged commit 9b5995f into apache:main Dec 30, 2024
26 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