gh-137952: update csv.Sniffer().has_header() docs to describe the actual off-by-onish behavior
#137953
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
bedevere-app
bot
added
awaiting review
docs
maurycy
changed the title
csv.Sniffer().has_header docs to describe the actual off-by-onish behaviorcsv.Sniffer().has_header() docs to describe the actual off-by-onish behavior
Co-authored-by: Stan Ulbrych <[email protected]>
eendebakpt
reviewed
Sep 1, 2025
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.
Please see gh-137952 for the context.
The question is whether we should fix the docs or the code.
I err on the docs:
csv.Sniffer()is very old, users may rely on this behavior without knowing it.csv.Sniffer().has_header()checks 21, not 20 rows, contrary to what the docs say #137952📚 Documentation preview 📚: https://cpython-previews--137953.org.readthedocs.build/