Skip to content

Migrate Array function Documentation to code - #12948

Merged
alamb merged 5 commits into
apache:mainfrom
jonathanc-n:migrate-array
Oct 16, 2024
Merged

Migrate Array function Documentation to code#12948
alamb merged 5 commits into
apache:mainfrom
jonathanc-n:migrate-array

Conversation

@jonathanc-n

@jonathanc-njonathanc-n commented Oct 15, 2024

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Closes#12927 .

Rationale for this change

What changes are included in this PR?

Moved the static array docs to the new one.

Are these changes tested?

Are there any user-facing changes?

@github-actionsgithub-actionsBot added the documentation Improvements or additions to documentation label Oct 15, 2024
@jonathanc-n

jonathanc-n commented Oct 15, 2024•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@Omega359@alamb Not too sure where to put the unnest documentation here.

@alambalamb changed the title Migrate Array DocumentationMigrate Array Documentation to codeOct 15, 2024
@alambalamb changed the title Migrate Array Documentation to codeMigrate Array function Documentation to codeOct 15, 2024
alamb
alamb approved these changes Oct 15, 2024
View reviewed changes

@alambalamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you so much @jonathanc-n -- this is epic

I went through this PR carefully and it all looks good to me

Comment threaddocs/source/user-guide/sql/scalar_functions.md

## Struct Functions

- [unnest](#unnest-struct)

@alambalambOct 15, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think unnest is special and not a scalar function. Perhaps as a follow on PR we can make a new page called "Special Functions" and put it there.

@jonathanc-njonathanc-nOct 15, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Yeah, I can create one for that

@Omega359Omega359Oct 20, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The only other special function I know of is make_map. See

datafusion/datafusion/sql/src/expr/function.rs

Line 229 in 972e3ab

if name.eq("make_map"){

@Omega359Omega359Oct 21, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Filed as #13036

Comment threaddatafusion/functions-nested/src/extract.rs
Comment threaddatafusion/functions-nested/src/flatten.rs
}
static DOCUMENTATION: OnceLock<Documentation> = OnceLock::new();

fn get_flatten_doc() -> &'static Documentation {

@alambalambOct 15, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is so nice to have this documentation as part of the function

Comment threaddatafusion/functions-nested/src/make_array.rs Outdated
@alamb

alamb commented Oct 16, 2024

Copy link
Copy Markdown
Contributor

I ran ./dev/update_function_docs.sh and merged up from main to get the CI passing on this PR

@alamb
alamb merged commit 91899d4 into apache:mainOct 16, 2024
@alamb

alamb commented Oct 16, 2024

Copy link
Copy Markdown
Contributor

🚀

This was referenced Oct 20, 2024
Closed
Closed
@jonathanc-njonathanc-n mentioned this pull request Oct 21, 2024
Merged
@jonathanc-n
jonathanc-n deleted the migrate-array branch November 7, 2024 01:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alambalambalamb approved these changes
+1 more reviewer
@Omega359Omega359Omega359 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Migrate documentation for all array functions from scalar_functions.md to code

3 participants

@jonathanc-n@alamb@Omega359