Minor: Improve documentation for catalog.has_header config option
#10452
Conversation
This file contains hidden or 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
findepi
pushed a commit
to findepi/datafusion
that referenced
this pull request
Jul 16, 2024
…pache#10452) * Minor: document catalog.has_header better * update docs * update test
# for free
to join this conversation on GitHub.
Already have an account?
# 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
While reviewing #10404 I found the documentation on this config option a little confusing and go read code to understand what it did.
I would like to document it better for my future self (and hopefully others)
What changes are included in this PR?
Update doc string for catalog.has_header config
Are these changes tested?
Are there any user-facing changes?