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

docs: Add alternative syntax for extract, trim and substring. #13143

Merged
merged 1 commit into from
Oct 29, 2024

Conversation

Omega359
Copy link
Contributor

Which issue does this PR close?

Related to #13139, discussed in #13036

Rationale for this change

Complete documentation for functions with alternative syntax

What changes are included in this PR?

doc updates only

Are these changes tested?

Yes.

Are there any user-facing changes?

Documentation

@github-actions github-actions bot added documentation Improvements or additions to documentation functions labels Oct 28, 2024
@@ -124,6 +124,8 @@ fn get_btrim_doc() -> &'static Documentation {
```"#)
.with_standard_argument("str", Some("String"))
.with_argument("trim_str", "String expression to operate on. Can be a constant, column, or function, and any combination of operators. _Default is whitespace characters._")
.with_alternative_syntax("trim(BOTH trim_str FROM str)")
.with_alternative_syntax("trim(trim_str FROM str)")
Copy link
Member

Choose a reason for hiding this comment

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

Does this deserve new SLT test cases?

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 grabbed the syntax from an slt test :)

@Omega359 Omega359 marked this pull request as ready for review October 28, 2024 14:32
@jatin510
Copy link
Contributor

lgtm 👍

Copy link
Contributor

@jonathanc-n jonathanc-n left a comment

Choose a reason for hiding this comment

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

This looks good to me. We're pretty close!

@Omega359 Omega359 changed the title Add alternative syntax for extract, trim and substring. docs: Add alternative syntax for extract, trim and substring. Oct 29, 2024
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

@alamb alamb merged commit feeb32a into apache:main Oct 29, 2024
26 checks passed
@Omega359 Omega359 deleted the feature/alternative_syntax_doc branch October 29, 2024 19:08
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 functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants