Prefer using [start, end] offset instead of sub string (#1387)

microsoft · Dec 18, 2023 · 3f725d8 · 3f725d8
1 parent 692e892
commit 3f725d8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/types/src/main.ts b/types/src/main.ts
@@ -2595,6 +2595,10 @@ export interface ParameterInformation {
 	 * signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
 	 * string representation as `Position` and `Range` does.
 	 *
+	 * To avoid ambiguities a server should use the [start, end] offset value instead of using
+	 * a substring. Whether a client support this is controlled via `labelOffsetSupport` client
+	 * capability.
+	 *
 	 * *Note*: a label of type string should be a substring of its containing signature label.
 	 * Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
 	 */