Fix Javadoc for CSVPrinter.getRecordCount(): the header record written by the constructor is counted - #633
Merged
garydgregory merged 1 commit intoSep 7, 2026
Conversation
… the constructor is counted
uros-b
approved these changes
Sep 6, 2026
Member
|
Nice javadoc update @lenamonj! |
Member
|
@lenamonj Thank you for the PR, merged 🚀 |
garydgregory
changed the title
garydgregory
added a commit
that referenced
this pull request
Sep 7, 2026
by the constructor is counted (#633).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
CSVPrinter.getRecordCount()says "this does not include comments or headers", but the header record the constructor writes is counted: the test added with the method in CSV-313 asserts a count of 1 right after the header ("The header is the first record"). A caller reading the Javadoc gets one fewer than the printer reports whenever the format carries a header.Javadoc only. It now says the constructor's header record is counted and that comments and
printHeaders(ResultSet)are not.Verified with the default
mvngoal (checkstyle, PMD, SpotBugs, japicmp, RAT).Found by an automated review loop I run; the change was reviewed and verified by me.