Fixes #2080: deprecate the top-level activeParameter property or update the documentation to clearly explain why there are two of them

This commit is contained in:
Dirk Baeumer 2025-12-11 11:20:59 +01:00
parent d33a03cbf1
commit 3bbc1be4ee
No known key found for this signature in database
GPG key ID: DD95715335E91385
2 changed files with 5 additions and 6 deletions

View file

@ -221,9 +221,9 @@ export interface SignatureHelp {
* lies outside the range of `signatures[activeSignature].parameters`
* defaults to 0 if the active signature has parameters. If
* the active signature has no parameters it is ignored.
* In future version of the protocol this property might become
* mandatory to better express the active parameter if the
* active signature does have any.
*
* Since version 3.16.0 the `SignatureInformation` itself provides a
* `activeParameter` property and it should be used instead of this one.
*/
activeParameter?: uinteger;
}

View file

@ -240,9 +240,8 @@ export interface SignatureHelp {
*
* If the active signature has no parameters, it is ignored.
*
* In future versions of the protocol this property might become
* mandatory (but still nullable) to better express the active parameter if
* the active signature does have any.
* Since version 3.16.0 the `SignatureInformation` itself provides a
* `activeParameter` property and it should be used instead of this one.
*/
activeParameter?: uinteger | null;
}