Fix comments

rbuckton · rbuckton · commit d7de7524a9b5 · 2023-01-19T14:39:24.000-05:00
diff --git a/src/server/protocol.ts b/src/server/protocol.ts
@@ -3527,16 +3527,14 @@ export interface UserPreferences {
      * [Unicode Collation Algorithm](https://unicode.org/reports/tr10/#Scope)) using rules associated with the locale
      * specified in {@link organizeImportsCollationLocale}.
      *
-     * NOTE: When comparing paths `"ordinal"` collation is always used.
-     *
      * Default: `"ordinal"`.
      */
     readonly organizeImportsCollation?: "ordinal" | "unicode";
     /**
-     * Indicates the locale to use for "natural" collation. If not specified, the locale `"en"` is used as an invariant
+     * Indicates the locale to use for "unicode" collation. If not specified, the locale `"en"` is used as an invariant
      * for the sake of consistent sorting. Use `"auto"` to use the detected UI locale.
      *
-     * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+     * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
      *
      * Default: `"en"`
      */
@@ -3545,7 +3543,7 @@ export interface UserPreferences {
      * Indicates whether numeric collation should be used for digit sequences in strings. When `true`, will collate
      * strings such that `a1z < a2z < a100z`. When `false`, will collate strings such that `a1z < a100z < a2z`.
      *
-     * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+     * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
      *
      * Default: `true`
      */
@@ -3555,7 +3553,7 @@ export interface UserPreferences {
      * `true`, characters with accents and other diacritics will be collated in the order defined by the locale specified
      * in {@link organizeImportsCollationLocale}.
      *
-     * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+     * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
      *
      * Default: `true`
      */
@@ -3564,7 +3562,7 @@ export interface UserPreferences {
      * Indicates whether upper case or lower case should sort first. When `false`, the default order for the locale
      * specified in {@link organizeImportsCollationLocale} is used.
      *
-     * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+     * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
      *
      * Default: `false`
      */
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -2812,16 +2812,14 @@ declare namespace ts {
                  * [Unicode Collation Algorithm](https://unicode.org/reports/tr10/#Scope)) using rules associated with the locale
                  * specified in {@link organizeImportsCollationLocale}.
                  *
-                 * NOTE: When comparing paths `"ordinal"` collation is always used.
-                 *
                  * Default: `"ordinal"`.
                  */
                 readonly organizeImportsCollation?: "ordinal" | "unicode";
                 /**
-                 * Indicates the locale to use for "natural" collation. If not specified, the locale `"en"` is used as an invariant
+                 * Indicates the locale to use for "unicode" collation. If not specified, the locale `"en"` is used as an invariant
                  * for the sake of consistent sorting. Use `"auto"` to use the detected UI locale.
                  *
-                 * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+                 * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
                  *
                  * Default: `"en"`
                  */
@@ -2830,7 +2828,7 @@ declare namespace ts {
                  * Indicates whether numeric collation should be used for digit sequences in strings. When `true`, will collate
                  * strings such that `a1z < a2z < a100z`. When `false`, will collate strings such that `a1z < a100z < a2z`.
                  *
-                 * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+                 * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
                  *
                  * Default: `true`
                  */
@@ -2840,7 +2838,7 @@ declare namespace ts {
                  * `true`, characters with accents and other diacritics will be collated in the order defined by the locale specified
                  * in {@link organizeImportsCollationLocale}.
                  *
-                 * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+                 * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
                  *
                  * Default: `true`
                  */
@@ -2849,7 +2847,7 @@ declare namespace ts {
                  * Indicates whether upper case or lower case should sort first. When `false`, the default order for the locale
                  * specified in {@link organizeImportsCollationLocale} is used.
                  *
-                 * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
+                 * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
                  *
                  * Default: `false`
                  */

Original file line number	Diff line number	Diff line change
`@@ -3527,16 +3527,14 @@ export interface UserPreferences {`
`3527`	`3527`	`* [Unicode Collation Algorithm](https://unicode.org/reports/tr10/#Scope)) using rules associated with the locale`
`3528`	`3528`	`* specified in {@link organizeImportsCollationLocale}.`
`3529`	`3529`	`*`
`3530`		- * NOTE: When comparing paths `"ordinal"` collation is always used.
`3531`		`- *`
`3532`	`3530`	* Default: `"ordinal"`.
`3533`	`3531`	`*/`
`3534`	`3532`	`readonly organizeImportsCollation?: "ordinal" \| "unicode";`
`3535`	`3533`	`/**`
`3536`		- * Indicates the locale to use for "natural" collation. If not specified, the locale `"en"` is used as an invariant
	`3534`	+ * Indicates the locale to use for "unicode" collation. If not specified, the locale `"en"` is used as an invariant
`3537`	`3535`	* for the sake of consistent sorting. Use `"auto"` to use the detected UI locale.
`3538`	`3536`	`*`
`3539`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`3537`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`3540`	`3538`	`*`
`3541`	`3539`	* Default: `"en"`
`3542`	`3540`	`*/`
`@@ -3545,7 +3543,7 @@ export interface UserPreferences {`
`3545`	`3543`	* Indicates whether numeric collation should be used for digit sequences in strings. When `true`, will collate
`3546`	`3544`	* strings such that `a1z < a2z < a100z`. When `false`, will collate strings such that `a1z < a100z < a2z`.
`3547`	`3545`	`*`
`3548`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`3546`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`3549`	`3547`	`*`
`3550`	`3548`	* Default: `true`
`3551`	`3549`	`*/`
`@@ -3555,7 +3553,7 @@ export interface UserPreferences {`
`3555`	`3553`	* `true`, characters with accents and other diacritics will be collated in the order defined by the locale specified
`3556`	`3554`	`* in {@link organizeImportsCollationLocale}.`
`3557`	`3555`	`*`
`3558`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`3556`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`3559`	`3557`	`*`
`3560`	`3558`	* Default: `true`
`3561`	`3559`	`*/`
`@@ -3564,7 +3562,7 @@ export interface UserPreferences {`
`3564`	`3562`	* Indicates whether upper case or lower case should sort first. When `false`, the default order for the locale
`3565`	`3563`	`* specified in {@link organizeImportsCollationLocale} is used.`
`3566`	`3564`	`*`
`3567`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`3565`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`3568`	`3566`	`*`
`3569`	`3567`	* Default: `false`
`3570`	`3568`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -2812,16 +2812,14 @@ declare namespace ts {`
`2812`	`2812`	`* [Unicode Collation Algorithm](https://unicode.org/reports/tr10/#Scope)) using rules associated with the locale`
`2813`	`2813`	`* specified in {@link organizeImportsCollationLocale}.`
`2814`	`2814`	`*`
`2815`		- * NOTE: When comparing paths `"ordinal"` collation is always used.
`2816`		`- *`
`2817`	`2815`	* Default: `"ordinal"`.
`2818`	`2816`	`*/`
`2819`	`2817`	`readonly organizeImportsCollation?: "ordinal" \| "unicode";`
`2820`	`2818`	`/**`
`2821`		- * Indicates the locale to use for "natural" collation. If not specified, the locale `"en"` is used as an invariant
	`2819`	+ * Indicates the locale to use for "unicode" collation. If not specified, the locale `"en"` is used as an invariant
`2822`	`2820`	* for the sake of consistent sorting. Use `"auto"` to use the detected UI locale.
`2823`	`2821`	`*`
`2824`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`2822`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`2825`	`2823`	`*`
`2826`	`2824`	* Default: `"en"`
`2827`	`2825`	`*/`
`@@ -2830,7 +2828,7 @@ declare namespace ts {`
`2830`	`2828`	* Indicates whether numeric collation should be used for digit sequences in strings. When `true`, will collate
`2831`	`2829`	* strings such that `a1z < a2z < a100z`. When `false`, will collate strings such that `a1z < a100z < a2z`.
`2832`	`2830`	`*`
`2833`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`2831`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`2834`	`2832`	`*`
`2835`	`2833`	* Default: `true`
`2836`	`2834`	`*/`
`@@ -2840,7 +2838,7 @@ declare namespace ts {`
`2840`	`2838`	* `true`, characters with accents and other diacritics will be collated in the order defined by the locale specified
`2841`	`2839`	`* in {@link organizeImportsCollationLocale}.`
`2842`	`2840`	`*`
`2843`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`2841`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`2844`	`2842`	`*`
`2845`	`2843`	* Default: `true`
`2846`	`2844`	`*/`
`@@ -2849,7 +2847,7 @@ declare namespace ts {`
`2849`	`2847`	* Indicates whether upper case or lower case should sort first. When `false`, the default order for the locale
`2850`	`2848`	`* specified in {@link organizeImportsCollationLocale} is used.`
`2851`	`2849`	`*`
`2852`		- * This preference is ignored if {@link organizeImportsCollation} is not `"natural"`.
	`2850`	+ * This preference is ignored if {@link organizeImportsCollation} is not `"unicode"`.
`2853`	`2851`	`*`
`2854`	`2852`	* Default: `false`
`2855`	`2853`	`*/`