Skip to content

Minor: Improve PruningPredicate docstrings#8748

Merged
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/pruning_docs
Jan 5, 2024
Merged

Minor: Improve PruningPredicate docstrings#8748
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/pruning_docs

Conversation

@alamb
Copy link
Copy Markdown
Contributor

@alamb alamb commented Jan 4, 2024

Which issue does this PR close?

Related to #7869

Rationale for this change

As we have extended the PruningPredicate's features and scope, we should also improve its documentation to match.

What changes are included in this PR?

Improve the PruningPredicate doc strings to reflect its ongoing changes

Are these changes tested?

via doctests

Are there any user-facing changes?

Doc strings only. No code changes

@github-actions github-actions Bot added the core Core DataFusion crate label Jan 4, 2024
@alamb alamb added the documentation Improvements or additions to documentation label Jan 4, 2024
@alamb alamb requested review from Ted-Jiang and waynexia January 4, 2024 14:23
@alamb
Copy link
Copy Markdown
Contributor Author

alamb commented Jan 4, 2024

fyi @my-vegetable-has-exploded and @yahoNanJing

Copy link
Copy Markdown
Member

@Ted-Jiang Ted-Jiang left a comment

Choose a reason for hiding this comment

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

👍 Nice write up.

@alamb
Copy link
Copy Markdown
Contributor Author

alamb commented Jan 5, 2024

👍 Nice write up.

Thank you @Ted-Jiang !

@alamb alamb changed the title Minor: Improve PruningPredicate docstrings more Minor: Improve PruningPredicate docstrings Jan 5, 2024
@alamb alamb merged commit 4173070 into apache:main Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants