[Javadoc] Clarify behavior of deprecated CSVFormat#withFirstRecordAsHeader()#598
Merged
garydgregory merged 2 commits intoapache:masterfrom Mar 2, 2026
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
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.
Description:
This PR updates the Javadoc of the deprecated method
CSVFormat.withFirstRecordAsHeader()to clearly explain its behavior.Previously, the Javadoc was ambiguous: it suggested that calling this method returns a
CSVFormat“equal to this but using the first record as header,” but it did not mention that previously set headers are reset to empty and thatskipHeaderRecordis automatically set totrue.This update adds a note to the Javadoc to make the behavior clear for users, without changing any runtime behavior.
No code behavior is changed; this is purely a documentation improvement.
mvn; that'smvnon the command line by itself.