Skip to content

Fix confusing javadoc documentation for reportLinesUnchanged #186

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

Merged
merged 1 commit into from
Apr 3, 2024

Conversation

anomal
Copy link
Contributor

@anomal anomal commented Mar 29, 2024

The original javadoc comments has problems:

  • Typo on "originial"
  • Typo on "reportLinesUnWrappedchanged"
  • Refers to internal code/processing logic over public API
  • Can be interpreted to mean DiffRow.Tags would be absent
  • Does not clearly disambiguate that reportLinesUnchanged is not a flag to omit the lines with DiffRow.Tag.EQUAL

I spent hours trying to figure out why setting reportLinesUnchanged to false still reports the lines that are unchanged. I had to go through the source code to figure out what this method was for.

@anomal anomal changed the title Fix confusing javadoc documentation for reportLinesUnWrapped Fix confusing javadoc documentation for reportLinesUnchanged Mar 29, 2024
@wumpz wumpz merged commit 6279142 into java-diff-utils:master Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants