Unified differ interface and source tracing improvements #176
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
pmbittner
reviewed
Oct 26, 2025
src/main/java/org/variantsync/diffdetective/variation/diff/Differ.java
Outdated
Show resolved
Hide resolved
pmbittner
requested changes
Oct 29, 2025
Member
pmbittner
left a comment
pmbittner
left a comment
There was a problem hiding this comment.
I appreciate these changes and I am very happy about the detailed documentation! Good job!
There are a few things regarding documentation and naming things I would like resolve though before I am willing to merge.
src/main/java/org/variantsync/diffdetective/variation/diff/Differs.java
Outdated
Show resolved
Hide resolved
src/main/java/org/variantsync/diffdetective/variation/diff/Differs.java
Outdated
Show resolved
Hide resolved
src/main/java/org/variantsync/diffdetective/variation/diff/Differs.java
Outdated
Show resolved
Hide resolved
src/main/java/org/variantsync/diffdetective/variation/diff/Differs.java
Outdated
Show resolved
Hide resolved
src/main/java/org/variantsync/diffdetective/variation/diff/LineDiffer.java
Outdated
Show resolved
Hide resolved
ibbem
force-pushed
the
diff-interface
branch
2 times, most recently
from
2cc8b83 to
9b4c700
Compare
pmbittner
reviewed
Nov 3, 2025
Member
pmbittner
left a comment
pmbittner
left a comment
There was a problem hiding this comment.
Apart from one error affecting the README, I think this is ready to merge. Thank you very much. :)
pmbittner
added
documentation
pmbittner
approved these changes
Nov 3, 2025
The new mechanism is more flexible and provides more introspection capabilities. Furthermore, it provides more documentation about the intent of our source tracking.
Note about the visual abstract image: The image is purposefully placed in the `src` folder such that it is easy to reference from the Javadoc. Furthermore, the symlink from `docs` allows easy references from `README.md` makes it more discoverable. The direction of the symlink (`docs` to `src` instead of `src` to `docs`) is important because the Javadoc is moved during the build process. A symlink would thus be incorrect in the default javadoc location (`target/reports/apidocs/`) or the final destination (`docs/javadoc`) which is used by the Nix build and thus for Github pages.
pmbittner
force-pushed
the
diff-interface
branch
from
177adcf to
533ef27
Compare
Member
|
I rebased onto develop to merge now. |
pmbittner
force-pushed
the
diff-interface
branch
from
533ef27 to
d728ec6
Compare
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.
This PR addresses #146.
Along the way I improved the source tracing because it was necessary to correctly set the source of the returned
VariationDiffs :). During these changes I also did two other small, unrelated fixes.open questions:
Differs.lineDiffer(...).diff(...)where we currently use other convenience methods?VariationDiff.fromFile)?.