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 regr* aggregate functions to code #12871

Merged
merged 7 commits into from
Oct 22, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 11, 2024

Which issue does this PR close?

Part of #12827

Rationale for this change

#12861 from @jonathanc-n moves some of the aggregate function documentation to the code, but the regr functions are handled specially

What changes are included in this PR?

Move regr_* aggregate functions to code

Are these changes tested?

Yes y CI

Are there any user-facing changes?

@alamb alamb added the documentation Improvements or additions to documentation label Oct 11, 2024
@github-actions github-actions bot added the core Core DataFusion crate label Oct 11, 2024
@github-actions github-actions bot removed documentation Improvements or additions to documentation functions labels Oct 11, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation functions and removed core Core DataFusion crate labels Oct 11, 2024
@@ -76,23 +80,7 @@ impl Regr {
}
}

/*
Copy link
Contributor Author

Choose a reason for hiding this comment

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

drive by clean up -- I don't know why this code was commented out

Given input column Y and X: regr_slope(Y, X) returns the slope (k in Y = k*X + b) using minimal RSS fitting.",
)
.with_syntax_example("regr_slope(expression_y, expression_x)")
.with_standard_argument("expression_y", "Expression")
Copy link
Contributor

@Omega359 Omega359 Oct 17, 2024

Choose a reason for hiding this comment

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

This currently renders as Expression expression to operate on. Can be a constant, column, or function, and any combination of operators.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. Thank you

@Omega359
Copy link
Contributor

Beyond the one minor change this LGTM

Copy link
Contributor

@korowa korowa left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @alamb

@alamb
Copy link
Contributor Author

alamb commented Oct 21, 2024

Thank you for the review @korowa

Copy link
Contributor

@goldmedal goldmedal left a comment

Choose a reason for hiding this comment

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

Thanks @alamb it looks good to me 👍

@alamb
Copy link
Contributor Author

alamb commented Oct 22, 2024

🚀 let's do this. Thanks again @goldmedal and @korowa

@alamb alamb merged commit 227908f into apache:main Oct 22, 2024
25 checks passed
@alamb alamb deleted the alamb/regr_doc branch October 22, 2024 15:07
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.

4 participants