Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Javadoc on DelimitedLineTokenizer#substringWithTrimmedWhitespaceAndQuotesIfQuotesPresent is wrong [BATCH-2758] #846

Closed
spring-issuemaster opened this issue Sep 13, 2018 · 3 comments

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Sep 13, 2018

bpagnier opened BATCH-2758 and commented

Nevermind, the Javadoc is clear I just didn't understand it correctly.
You can close the ticket !


Affects: 4.1.0.M3

Referenced from: commits 2d7caa3, 96e6ae2

Backported to: 4.2.0.M1, 4.1.1

@spring-issuemaster
Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Oct 31, 2018

Dimitrios Liapis commented

This ticket could be closed

@spring-issuemaster
Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Nov 2, 2018

Mahmoud Ben Hassine commented

It can be closed but still, it contains a typo which may have created the confusion in the first place. I fixed it with 2d7caa322249789056a70951f59d852f075a0f2f.

That said, I don't understand this javadoc on a private method.. and why the reporter ended up reading it. This javadoc should be a multiline comment. My concern is that if someone needs to read a comment on a private method in the source code, this means we have a gap or something not properly documented in the public API (be it in the javadoc or the reference documentation).

Anyway, I'm resolving the issue.

@spring-issuemaster
Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Nov 2, 2018

Dimitrios Liapis commented

Mahmoud Ben Hassine I see your point now I actually haven't noticed it's a private method.

I'm guessing the OP ended up there during a debug session trying to figure out why a line was splitted in such a way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.