Skip to content

fix: correct comment in strdist #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
letFunny wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: correct comment in strdist #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions internal/strdist/strdist.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ func StandardCost(ar, br rune) Cost {
// Distance returns the edit distance between two strings. The cost per edit is
// given by the costFunc argument.
//
// There is an optional cut argument that when set will finish the computation
// as early as possible once the final cost is certain to be >= cut. There is
// no guarantee about the exact cost returned when this is the case other than
// being >= cut. In particular, when cut is used, the function is not symmetric
// on a and b.
// When cut > 0, the computation will finish as early as possible once the
// final cost is certain to be >= cut. There is no guarantee about the exact
// cost returned when this is the case other than being >= cut. In particular,
// when cut is used, the function is not symmetric on a and b.
func Distance(a, b string, f CostFunc, cut int64) int64 {
if a == b {
return 0
Expand Down
Loading