Make Definitions agree with the enum about tool order - #796
Merged
Conversation
Both files carry a "keep in sync" comment and they had drifted in two places: TortoiseMerge sat before the TortoiseGit pair in the enum and after it in Definitions, and the enum had VisualStudio before Cursor while Definitions had them the other way round. That matters because the two lists are used for different things. The enum is the default resolution order - OrderReader hands back Enum.GetValues - while the generated docs and the remainder after a DiffEngine_ToolOrder prefix follow Definitions. So the published order was not the order tools actually resolve in, and a user reading the docs to pick a prefix was reading the wrong list. Definitions moves to match the enum, since the enum is what actually decides. Generated docs regenerated to match. The test that exists to catch this could not: IsEquivalentTo is order insensitive by default, so it passed on both lists. IsEqualTo is no good either - on two lists it compares references - so the assertion joins them, which is order sensitive and names the first tool that differs instead of reporting that the contents match.
This was referenced Aug 26, 2026
This was referenced Aug 27, 2026
Closed
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
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.
Both files carry a "keep in sync" comment and they had drifted in two places:
TortoiseMerge sat before the TortoiseGit pair in the enum and after it in
Definitions, and the enum had VisualStudio before Cursor while Definitions had
them the other way round.
That matters because the two lists are used for different things. The enum is
the default resolution order - OrderReader hands back Enum.GetValues - while the
generated docs and the remainder after a DiffEngine_ToolOrder prefix follow
Definitions. So the published order was not the order tools actually resolve in,
and a user reading the docs to pick a prefix was reading the wrong list.
Definitions moves to match the enum, since the enum is what actually decides.
Generated docs regenerated to match.
The test that exists to catch this could not: IsEquivalentTo is order
insensitive by default, so it passed on both lists. IsEqualTo is no good either
order sensitive and names the first tool that differs instead of reporting that
the contents match.