go-diff icon indicating copy to clipboard operation
go-diff copied to clipboard

What is the checklines parameter?

Open dmjones opened this issue 7 years ago • 1 comments

The docs for DiffMain and DiffMainRunes don't explain what the checklines parameter is used for.

Digging through the source, it looks like this has an impact on how the diff is calculated, if the input is large enough. But I'm unclear the pros and cons for choosing this.

Happy to make a PR to update the documentation if someone can advise on the use?

dmjones avatar Oct 10 '18 08:10 dmjones

From Java docs:

@param checklines Speedup flag. If false, then don't run a line-level diff first to identify the changed areas. If true, then run a faster slightly less optimal diff.

It would be great if you update the documentation with its definition!

sergi avatar Aug 01 '19 12:08 sergi