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 documentation for all math functions from scalar_functions.md to code #12908

Merged
merged 6 commits into from
Oct 15, 2024

Conversation

juroberttyb
Copy link
Contributor

Which issue does this PR close?

Closes #12867.

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added documentation Improvements or additions to documentation functions labels Oct 13, 2024
@juroberttyb juroberttyb changed the title migrate: math doc from static to code gen Migrate documentation for all math functions from scalar_functions.md to code Oct 13, 2024

pub fn get_pow_doc() -> &'static Documentation {
static DOCUMENTATION: OnceLock<Documentation> = OnceLock::new();

Copy link
Contributor

Choose a reason for hiding this comment

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

Aliases do not need documentation as the script that generates the docs will insert the alias link automatically

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No problem, this part is removed. Thank you for taking the time to review the PR!

@Omega359
Copy link
Contributor

Beyond the pow removal this PR LGTM 👍

@juroberttyb
Copy link
Contributor Author

PR updated with get_pow_doc() removed.

@juroberttyb juroberttyb requested a review from Omega359 October 13, 2024 15:04
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.

Thanks @Omega359 and @juroberttyb -- this is a great contribution. I started the CI checks on this PR

I'll plan to merge it in when the CI complete

Thank you!

@@ -27,534 +27,6 @@ the rest of the documentation.

[automatically created from the codebase]: https://github.com/apache/datafusion/issues/12740

## Math Functions
Copy link
Contributor

Choose a reason for hiding this comment

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

😍

@Omega359
Copy link
Contributor

Omega359 commented Oct 14, 2024

A small cargo fmt and clippy (unused import) fix seems to be required.

@juroberttyb
Copy link
Contributor Author

No problem. fmt and clippy applied.

Thank you both for taking the time to review this PR!

@alamb
Copy link
Contributor

alamb commented Oct 15, 2024

I took the liberty of merging up from main to resolve a conflict (also by pushing a commit I think this PR's CI will run automatically from now on)

@alamb alamb merged commit a9b202c into apache:main Oct 15, 2024
25 checks passed
@alamb
Copy link
Contributor

alamb commented Oct 15, 2024

Thanks again @juroberttyb and @Omega359

@juroberttyb
Copy link
Contributor Author

Thank you both for your time and help!

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.

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