jsdoc: Minor clarifications to priorityValue() docs

claremacrae · claremacrae · commit 819f0bf511a1 · 2024-11-02T18:59:41.000Z
diff --git a/src/lib/PriorityTools.ts b/src/lib/PriorityTools.ts
@@ -41,11 +41,12 @@ export class PriorityTools {
     }
 
     /**
-     * Get the {@link Priority} value from a string. The input string will be lower-cased.
+     * Get the {@link Priority} value from a string. The algorithm is case-insensitive.
      *
      * In case the value was not recognised, {@link Priority.None} will be returned.
      *
-     * @param priority
+     * @param priority - a string containing a name of one the supported {@link Priority} values.
+     *                   Capitalisation is ignored.
      * @see priorityNameUsingNormal
      */
     public static priorityValue(priority: string): Priority {

Original file line number	Diff line number	Diff line change
`@@ -41,11 +41,12 @@ export class PriorityTools {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * Get the {@link Priority} value from a string. The input string will be lower-cased.`
	`44`	`+ * Get the {@link Priority} value from a string. The algorithm is case-insensitive.`
`45`	`45`	`*`
`46`	`46`	`* In case the value was not recognised, {@link Priority.None} will be returned.`
`47`	`47`	`*`
`48`		`- * @param priority`
	`48`	`+ * @param priority - a string containing a name of one the supported {@link Priority} values.`
	`49`	`+ * Capitalisation is ignored.`
`49`	`50`	`* @see priorityNameUsingNormal`
`50`	`51`	`*/`
`51`	`52`	`public static priorityValue(priority: string): Priority {`