docs(text): pass check_docs.ts

_tools/check_docs.ts

@@ -33,6 +33,7 @@ const ENTRY_POINTS = [
   "../internal/mod.ts",
   "../jsonc/mod.ts",
   "../media_types/mod.ts",
+  "../text/mod.ts",
   "../ulid/mod.ts",
   "../webgpu/mod.ts",
 ] as const;
@@ -84,7 +85,7 @@ function assertHasReturnTag(document: { jsDoc: JsDoc; location: Location }) {
   const tag = document.jsDoc.tags?.find((tag) => tag.kind === "return");
   if (tag === undefined) {
     diagnostics.push(
-      new DocumentError("Symbol must have a @return tag", document),
+      new DocumentError("Symbol must have a @returns tag", document),
     );
   } else {
     assert(

text/case.ts

@@ -6,7 +6,7 @@ import { capitalizeWord, splitToWords } from "./_util.ts";
 /**
  * Converts a string into camelCase.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { toCamelCase } from "@std/text/case";
  *
@@ -25,7 +25,7 @@ export function toCamelCase(input: string): string {
 /**
  * Converts a string into kebab-case.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { toKebabCase } from "@std/text/case";
  *
@@ -43,7 +43,7 @@ export function toKebabCase(input: string): string {
 /**
  * Converts a string into PascalCase.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { toPascalCase } from "@std/text/case";
  *
@@ -61,7 +61,7 @@ export function toPascalCase(input: string): string {
 /**
  * Converts a string into snake_case.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { toSnakeCase } from "@std/text/case";
  * toSnakeCase("deno is awesome"); // "deno_is_awesome"

text/closest_string.ts

@@ -9,7 +9,7 @@ const getWordDistance = levenshteinDistance;
 /**
  * get most-similar word
  *
- * @example
+ * @example Usage
  * ```ts
  * import { closestString } from "@std/text/closest-string";
  *
@@ -19,9 +19,10 @@ const getWordDistance = levenshteinDistance;
  * const word = closestString("hep", possibleWords);
  * ```
  *
- * @param givenWord - The string to measure distance against
- * @param possibleWords - The string-array that will be sorted
- * @param options.caseSensitive - Flag indicating whether the distance should include case. Default is false.
+ * @param givenWord The string to measure distance against
+ * @param possibleWords The string-array that will be sorted
+ * @param options An options bag containing a `caseSensitive` flag indicating
+ * whether the distance should include case. Default is false.
  * @returns A sorted copy of possibleWords
  * @note
  * the ordering of words may change with version-updates

text/compare_similarity.ts

@@ -8,7 +8,14 @@ const getWordDistance = levenshteinDistance;
 /**
  * Sort based on word similarity
  *
- * @example
+ * @param givenWord The string to measure distance against.
+ * @param options An options bag containing a `caseSensitive` flag indicating
+ * whether the distance should include case. Default is false.
+ * @returns The difference in distance. This will be a negative number if `a`
+ * is more similar to `givenWord` than `b`, a positive number if `b` is more
+ * similar, or `0` if they are equally similar.
+ *
+ * @example Usage
  * ```ts
  * import { compareSimilarity } from "@std/text/compare-similarity";
  * const words = ["hi", "hello", "help"];

text/levenshtein_distance.ts

@@ -4,7 +4,7 @@
 /**
  * Calculates the Levenshtein distance between two strings.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { levenshteinDistance } from "@std/text/levenshtein-distance";
  * levenshteinDistance("aa", "bb"); // 2

text/word_similarity_sort.ts

@@ -5,7 +5,7 @@ import { compareSimilarity } from "./compare_similarity.ts";
 /**
  * Sorts a string-array by similarity to a given string
  *
- * @example
+ * @example Usage
  * ```ts
  * import { wordSimilaritySort } from "@std/text/word-similarity-sort";
  *
@@ -20,7 +20,8 @@ import { compareSimilarity } from "./compare_similarity.ts";
  *
  * @param givenWord - The string to measure distance against
  * @param possibleWords - The string-array that will be sorted
- * @param options.caseSensitive - Flag indicating whether the distance should include case. Default is false.
+ * @param options An options bag containing a `caseSensitive` flag indicating
+ * whether the distance should include case. Default is false.
  * @returns {string[]} A sorted copy of possibleWords
  */
 export function wordSimilaritySort(