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

Migrate Array function Documentation to code #12948

Merged
merged 5 commits into from
Oct 16, 2024

Conversation

jonathanc-n
Copy link
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-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 15, 2024
@jonathanc-n
Copy link
Contributor Author

jonathanc-n commented Oct 15, 2024

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

@alamb alamb changed the title Migrate Array Documentation Migrate Array Documentation to code Oct 15, 2024
@alamb alamb changed the title Migrate Array Documentation to code Migrate Array function Documentation to code Oct 15, 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.

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

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

#### Aliases

- generate_series

## Struct Functions

- [unnest](#unnest-struct)
Copy link
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.

Copy link
Contributor Author

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

Copy link
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

if name.eq("make_map") {

Copy link
Contributor

Choose a reason for hiding this comment

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

Filed as #13036

datafusion/functions-nested/src/extract.rs Show resolved Hide resolved
}
static DOCUMENTATION: OnceLock<Documentation> = OnceLock::new();

fn get_flatten_doc() -> &'static Documentation {
Copy link
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

datafusion/functions-nested/src/make_array.rs Outdated Show resolved Hide resolved
@alamb
Copy link
Contributor

alamb commented Oct 16, 2024

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:main Oct 16, 2024
25 checks passed
@alamb
Copy link
Contributor

alamb commented Oct 16, 2024

🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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