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

Minor: Fix doc links and typos #5225

Merged
merged 4 commits into from
Feb 10, 2023
Merged

Minor: Fix doc links and typos #5225

merged 4 commits into from
Feb 10, 2023

Conversation

Jefffrey
Copy link
Contributor

@Jefffrey Jefffrey commented Feb 9, 2023

Which issue does this PR close?

n/a

Rationale for this change

Fixing broken links that caused warnings when running cargo doc. Also fix some typos

What changes are included in this PR?

Are these changes tested?

cargo doc no longer generates warnings

Are there any user-facing changes?

@github-actions github-actions bot added core Core DataFusion crate logical-expr Logical plan and expressions optimizer Optimizer rules physical-expr Physical Expressions labels Feb 9, 2023
@@ -84,6 +84,8 @@ pub enum RewriteRecursion {
/// # See Also:
/// * [`Expr::accept`] to drive a rewriter through an [`Expr`]
/// * [`rewrite_expr`]: For rewriting an [`Expr`] using functions
///
/// [`Expr::accept`]: crate::expr_visitor::ExprVisitable::accept
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this isn't the right link, but i couldn't figure out how to link to the Expr method implementation instead of just the ExprVisitable trait method itself.

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, it is better than a broken link -- thank you!

@Jefffrey Jefffrey marked this pull request as draft February 9, 2023 20:52
@Jefffrey Jefffrey marked this pull request as ready for review February 10, 2023 08:11
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.

Looks great to me -- thank you so much @Jefffrey for the contribution

@@ -84,6 +84,8 @@ pub enum RewriteRecursion {
/// # See Also:
/// * [`Expr::accept`] to drive a rewriter through an [`Expr`]
/// * [`rewrite_expr`]: For rewriting an [`Expr`] using functions
///
/// [`Expr::accept`]: crate::expr_visitor::ExprVisitable::accept
Copy link
Contributor

Choose a reason for hiding this comment

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

Well, it is better than a broken link -- thank you!

@alamb alamb changed the title Fix doc links and typos Minor: Fix doc links and typos Feb 10, 2023
@alamb alamb merged commit eda875b into apache:master Feb 10, 2023
@ursabot
Copy link

ursabot commented Feb 10, 2023

Benchmark runs are scheduled for baseline = 8f3c8c3 and contender = eda875b. eda875b is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@Jefffrey Jefffrey deleted the doc_cleanup branch February 10, 2023 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate logical-expr Logical plan and expressions optimizer Optimizer rules physical-expr Physical Expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants