Skip to content

Commit dce781b

Browse files
committed
docs: clarify behavior of deprecated withFirstRecordAsHeader()
1 parent 8dd9f4e commit dce781b

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

src/main/java/org/apache/commons/csv/CSVFormat.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2788,6 +2788,9 @@ public CSVFormat withEscape(final Character escape) {
27882788
* .get();
27892789
* </pre>
27902790
*
2791+
* <p><b>Note:</b> Any previously set headers are reset to empty.
2792+
* The resulting format will have {@code skipHeaderRecord = true}.</p>
2793+
*
27912794
* @return A new CSVFormat that is equal to this but using the first record as header.
27922795
* @see Builder#setSkipHeaderRecord(boolean)
27932796
* @see Builder#setHeader(String...)

0 commit comments

Comments
 (0)