Skip to content

Improve documentation for filter pushdown #23

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

Merged
merged 1 commit into from
Apr 7, 2025

Conversation

alamb
Copy link

@alamb alamb commented Apr 7, 2025

Rather than leaving a bunch of messy suggestions inline I just made a PR with suggestions for doc improvements. I'll comment inline

/// to try and push down
/// * `config`: The configuration options for execution
///
/// # Default Implementation
Copy link
Author

Choose a reason for hiding this comment

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

I expanded the intro a bit more and added headings for your (great!) examples

return Err(DataFusionError::Internal(
"Child plan did not have any filters pushed down".to_string(),
));
return internal_err!(
Copy link
Author

Choose a reason for hiding this comment

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

a minor cleanup

@alamb
Copy link
Author

alamb commented Apr 7, 2025

FYI @adriangb

@adriangb adriangb merged commit 8edd65f into pydantic:filter-pushdown-apis Apr 7, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants