From 87e6e6580990c644442973411c60d08d6531f0e0 Mon Sep 17 00:00:00 2001 From: Infendro Date: Sat, 10 Jan 2026 15:12:36 +0100 Subject: [PATCH] improve string distance documentation --- src/commonMain/kotlin/com/infendro/cli/util/Distance.kt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/commonMain/kotlin/com/infendro/cli/util/Distance.kt b/src/commonMain/kotlin/com/infendro/cli/util/Distance.kt index b11ca6b..46977f2 100644 --- a/src/commonMain/kotlin/com/infendro/cli/util/Distance.kt +++ b/src/commonMain/kotlin/com/infendro/cli/util/Distance.kt @@ -3,7 +3,13 @@ package com.infendro.cli.util internal const val threshold = 2 /** - * Damerau-Levenshtein string distance + * Calculates the Damerau-Levenshtein distance between two strings. + * + * The distance is the minimum number of operations (insertion, deletion, substitution, and transposition) required to transform one string into another. + * + * @param a The source string. + * @param b The target string. + * @return The minimum number of operations to transform [a] into [b]. */ internal fun distance(a: String, b: String): Int { if (a == b) return 0