You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "Chen-Yuan-Lai (via GitHub)" <gi...@apache.org> on 2024/12/27 15:50:58 UTC
[PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Chen-Yuan-Lai opened a new pull request, #13924:
URL: https://github.com/apache/datafusion/pull/13924
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #13671 .
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes 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?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#discussion_r1899456067
##########
docs/source/user-guide/sql/scalar_functions.md:
##########
@@ -852,10 +852,6 @@ btrim(str[, trim_str])
#### Alternative Syntax
-```sql
-trim(BOTH trim_str FROM str)
-```
-
```sql
trim(trim_str FROM str)
```
Review Comment:
- I filed https://github.com/apache/datafusion/issues/13944 to track
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#discussion_r1899182207
##########
docs/source/user-guide/sql/scalar_functions.md:
##########
@@ -852,10 +852,6 @@ btrim(str[, trim_str])
#### Alternative Syntax
-```sql
-trim(BOTH trim_str FROM str)
-```
-
```sql
trim(trim_str FROM str)
```
Review Comment:
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`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#discussion_r1899182342
##########
docs/source/user-guide/sql/scalar_functions.md:
##########
@@ -852,10 +852,6 @@ btrim(str[, trim_str])
#### Alternative Syntax
-```sql
-trim(BOTH trim_str FROM str)
-```
-
```sql
trim(trim_str FROM str)
```
Review Comment:
Lets leave trim not migrated for now and we can do it once the doc macros fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "Omega359 (via GitHub)" <gi...@apache.org>.
Omega359 commented on PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#issuecomment-2564361046
I believe you may have forgotten to run the doc generation script prior to pushing this change
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead merged PR #13924:
URL: https://github.com/apache/datafusion/pull/13924
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "Chen-Yuan-Lai (via GitHub)" <gi...@apache.org>.
Chen-Yuan-Lai commented on code in PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#discussion_r1899130452
##########
docs/source/user-guide/sql/scalar_functions.md:
##########
@@ -852,10 +852,6 @@ btrim(str[, trim_str])
#### Alternative Syntax
-```sql
-trim(BOTH trim_str FROM str)
-```
-
```sql
trim(trim_str FROM str)
```
Review Comment:
@comphead I found that `use_doc()` only supports one alternative syntax. Should we modify it to support multiple alternative syntaxes?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "Chen-Yuan-Lai (via GitHub)" <gi...@apache.org>.
Chen-Yuan-Lai commented on PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#issuecomment-2564361748
@Omega359 Yes 😢 I'll run doc generation script for other PRs altogether. Thanks for reviewing 🙏
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] doc-gen: migrate scalar functions (string) documentation 1/4 [datafusion]
Posted by "Chen-Yuan-Lai (via GitHub)" <gi...@apache.org>.
Chen-Yuan-Lai commented on code in PR #13924:
URL: https://github.com/apache/datafusion/pull/13924#discussion_r1899559374
##########
docs/source/user-guide/sql/scalar_functions.md:
##########
@@ -852,10 +852,6 @@ btrim(str[, trim_str])
#### Alternative Syntax
-```sql
-trim(BOTH trim_str FROM str)
-```
-
```sql
trim(trim_str FROM str)
```
Review Comment:
I remove the change for `trim()` in this PR, thanks! I'd like to update `use_doc()` and migrate `trim()` simultaneously
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org