comparePlus icon indicating copy to clipboard operation
comparePlus copied to clipboard

Please add a descriptions for some commands

Open ArkadiuszMichalski opened this issue 4 years ago • 1 comments

Hi, @pnedev, I can't determine the behavior for the following commands:

1. `Base Changed Lines on Minimum Diffs` (from plugin menu).
2. `Align all matching lines` (from ComparePlus Settings).
3. `Never colorize ignored lines` (from ComparePlus Settings).

Descriptions in https://github.com/pnedev/compare-plugin/blob/master/Help.md (if exist) are not clear. Can you, of course in your free time, add short examples (data to compare) for each of these cases that will show the difference when we turn on/off them. And maybe update Help.md file with this informations (to avoid this kind of question in the future).

ArkadiuszMichalski avatar Apr 29 '20 19:04 ArkadiuszMichalski

Hi @ArkadiuszMichalski ,

Yes, sure, I'm willing to add help description sometime in the future but I don't know when that will happen. I do not have free time at all these days. I even find it hard to finish the few last issues and actually release the plugin. Sorry for my late reply.

'Align all matching lines' aligns each matching line between the files as well (if left and right views have different widths some lines might wrap-around in one view and not in the other).

'Never colorize ignored lines' affects difference colorization in cases when some lines are ignored. Imagine if you enable blank lines ignore and some added (or removed) blocks have blank lines. In that case by default the whole blocks will be colorized as added or removed or moved. If you enable the option the blanks will not be colorized.

The first option, 'Base changed lines on Minimum Diffs' if more difficult to describe and unfortunately I don't have example files at the moment. By default the decision which lines in a added-removed block pairs are considered changed is based on minimum not matching characters between the lines. If the option is enabled this decision is based on minimum differing line portions. I'll add example files later.

BR

pnedev avatar May 17 '20 15:05 pnedev