Minor: Improve DataFusionError documentation
#8792
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
removed
the
documentation
Jefffrey
reviewed
Jan 8, 2024
alamb
commented
Jan 8, 2024
Co-authored-by: Jeffrey Vo <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Part of #7013
Rationale for this change
Inspired by #8781 I have seen several cases where people are confused about when to use
DataFusionError::InternalvsDataFusionError::Plan. etcWhat changes are included in this PR?
Update doc comments for
DataFusionError, making liberal use of @crepererum 's great description #8781 (comment)Are these changes tested?
existing coverage
Are there any user-facing changes?
better documentation. No functional changes