[CSV-274] Add comments to iterator() and stream()#270
Merged
Conversation
garydgregory
requested changes
Oct 6, 2022
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #270 +/- ##
============================================
- Coverage 97.34% 97.34% -0.01%
Complexity 535 535
============================================
Files 11 11
Lines 1169 1167 -2
Branches 205 203 -2
============================================
- Hits 1138 1136 -2
Misses 18 18
Partials 13 13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
garydgregory
added a commit
that referenced
this pull request
Oct 7, 2022
| * <p> | ||
| * If it is necessary to construct an iterator which is usable after the | ||
| * parser is closed, one option is to extract all records as a list with | ||
| * {@link getRecords()}, and return an iterator to that list. |
Member
There was a problem hiding this comment.
@pedro-w For future reference: {@link getRecords()} is NOT legal Javadoc syntax, use {@link #getRecords()}
Contributor
Author
There was a problem hiding this comment.
Sorry, I didn't realise that (also I thought I'd addressed all the warnings displayed when building the project). I see you fixed it in 22df0e2, thanks!
| * | ||
| * <p> | ||
| * If the parser is closed, the stream will not produce any more values. | ||
| * See the comments in {@link iterator()}. |
Member
There was a problem hiding this comment.
@pedro-w For future reference: {@link iterator()} is NOT legal Javadoc syntax, use {@link #iterator()}
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
4 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.
This is purely an addition to the Javadocs, to call out what happens to an iterator or stream when the underlying
CSVParseris closed.https://issues.apache.org/jira/projects/CSV/issues/CSV-274