unformat icon indicating copy to clipboard operation
unformat copied to clipboard

Improve docs regarding command output

Open seanm opened this issue 8 years ago • 4 comments

Hi there. Just trying unformat, and am confused by its output. After running 30 minutes or so, it just keep repeating stuff like:

149: ........................................ (26, 168)
150: ........................................ (26, 168)
151: ........................................ (26, 168)
152: ........................................ (26, 168)

What are those numbers? Is it making progress? Is it stuck?

Might I suggest adding a paragraph in the docs explaining what's being output...

Thanks.

seanm avatar Oct 16 '17 03:10 seanm

Thanks for the suggestion. It's not making progress. It's quite possible that there simply isn't a config file that perfectly matches your existing code but determining whether that's the case is harder to do.

johnmcfarlane avatar Oct 19 '17 19:10 johnmcfarlane

Thanks for the suggestion. I will try and improve the docs accordingly.

Quick explanation: It's not making progress. It's quite possible that there simply isn't a config file that perfectly matches your existing code but determining whether that's the case is harder to do so it just keeps trying over and over.

johnmcfarlane avatar Oct 19 '17 20:10 johnmcfarlane

Hey John that doesn't quite help yet, I think I'm in the same boat as Sam with wanting to know what the actual numbers mean. First one is obviously iterations, but what are the two in brackets?

rlabrecque avatar Oct 30 '17 07:10 rlabrecque

Those are scores of the best configuration found in that generation. The first is an estimate of the number of lines that would be deleted if that configuration was applied and the second is the corresponding Levenshtein distance. They are purely diagnostic values. The important thing to note is that if they change, progress is being made.

johnmcfarlane avatar Oct 30 '17 14:10 johnmcfarlane