cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Rename `SuggestionsMinimumDistance` to `SuggestionsMaximumDistance`

Open mrpinsky opened this issue 2 years ago • 3 comments

Since Cobra will provide suggestions that are less than or equal to this value, it is a maximum, not a minimum.

I just noticed this and the cognitive dissonance was bugging me, but I understand if changing the public API without providing a new feature isn't worth it.

mrpinsky avatar Jun 14 '22 17:06 mrpinsky

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Nate Pinsky seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Jun 14 '22 17:06 CLAassistant

Thanks @mrpinsky. I believe your argument makes sense, "maximum" makes more sense.

However, as you point out, this is a public API so we are not allowed to change it. We'll just have to live with this terminology 😞

marckhouzam avatar Jun 14 '22 19:06 marckhouzam

I just noticed this and the cognitive dissonance was bugging me, but I understand if changing the public API without providing a new feature isn't worth it.

True. Changing anything in this public API is really tricky. This could be something we table for a v2.0.0 of Cobra if/when that ever happens.

jpmcb avatar Jun 15 '22 22:06 jpmcb