doc-gen: migrate scalar functions (encoding & regex) documentation #13919
+167
−181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
reviewed
Dec 28, 2024
There was a problem hiding this comment.
Thank you @Chen-Yuan-Lai 🎉
I noticed the CI is failing on this PR: https://github.com/apache/datafusion/actions/runs/12517861740/job/34921789845?pr=13919
It looks like some of the content is getting lost - when I ran ./dev/update_function_docs.sh locally, the results seem to show the regexp functions having lost their documentation 🤔
(venv) andrewlamb@Andrews-MacBook-Pro-2:~/Software/datafusion2$ git diff
diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.md
index be4f5e56b..f9585ce12 100644
--- a/docs/source/user-guide/sql/scalar_functions.md
+++ b/docs/source/user-guide/sql/scalar_functions.md
@@ -1729,12 +1729,12 @@ uuid()
Decode binary data from textual representation in string.
-decode(expression, format)
+decode(e xpression, format)
#### Arguments
-- **expression**: Expression containing encoded string data
+- **expression**: Expression containing string or binary data
- **format**: Same arguments as [encode](#encode)
**Related functions**:
@@ -1758,167 +1758,6 @@ encode(expression, format)
- [decode](#decode)
-## Regular Expression Functions
-
-Apache DataFusion uses a [PCRE-like](https://en.wikibooks.org/wiki/Regular_Expressions/Perl-Compatible_Regular_Expressions)
-regular expression [syntax](https://docs.rs/regex/latest/regex/#syntax)
-(minus support for several features including look-around and backreferences).
-The following regular expression functions are supported:
-
-- [regexp_count](#regexp_count)
-- [regexp_like](#regexp_like)
-- [regexp_match](#regexp_match)
-- [regexp_replace](#regexp_replace)
....
| #[user_doc( | ||
| doc_section(label = "Binary String Functions"), | ||
| description = "Decode binary data from textual representation in string.", | ||
| syntax_example = "decode(e xpression, format)", |
There was a problem hiding this comment.
Suggested change
| syntax_example = "decode(e xpression, format)", | |
| syntax_example = "decode(expression, format)", |
|
I think the PR is just a part of #13671. Modifying the |
|
Sure! I'll modfy all the other PRs. Thanks @goldmedal |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 builtin binary string and regular expression functions documentation that currently support migration.
Are these changes tested?
Are there any user-facing changes?