Skip to content

Commit

Permalink
Use consistent spelling (microsoft#332)
Browse files Browse the repository at this point in the history
  • Loading branch information
KamasamaK authored Sep 12, 2022
1 parent 84e122e commit 1f0a81b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions debugAdapterProtocol.json
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
"CancelRequest": {
"allOf": [ { "$ref": "#/definitions/Request" }, {
"type": "object",
"description": "The `cancel` request is used by the client in two situations:\n- to indicate that it is no longer interested in the result produced by a specific request issued earlier\n- to cancel a progress sequence. Clients should only call this request if the corresponding capability `supportsCancelRequest` is true.\nThis request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honouring this request but there are no guarantees.\nThe `cancel` request may return an error if it could not cancel an operation but a client should refrain from presenting this error to end users.\nThe request that got cancelled still needs to send a response back. This can either be a normal result (`success` attribute true) or an error response (`success` attribute false and the `message` set to `cancelled`).\nReturning partial results from a cancelled request is possible but please note that a client has no generic way for detecting that a response is partial or not.\nThe progress that got cancelled still needs to send a `progressEnd` event back.\n A client should not assume that progress just got cancelled after sending the `cancel` request.",
"description": "The `cancel` request is used by the client in two situations:\n- to indicate that it is no longer interested in the result produced by a specific request issued earlier\n- to cancel a progress sequence. Clients should only call this request if the corresponding capability `supportsCancelRequest` is true.\nThis request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honoring this request but there are no guarantees.\nThe `cancel` request may return an error if it could not cancel an operation but a client should refrain from presenting this error to end users.\nThe request that got cancelled still needs to send a response back. This can either be a normal result (`success` attribute true) or an error response (`success` attribute false and the `message` set to `cancelled`).\nReturning partial results from a cancelled request is possible but please note that a client has no generic way for detecting that a response is partial or not.\nThe progress that got cancelled still needs to send a `progressEnd` event back.\n A client should not assume that progress just got cancelled after sending the `cancel` request.",
"properties": {
"command": {
"type": "string",
Expand Down Expand Up @@ -539,7 +539,7 @@
"CapabilitiesEvent": {
"allOf": [ { "$ref": "#/definitions/Event" }, {
"type": "object",
"description": "The event indicates that one or more capabilities have changed.\nSince the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late).\nConsequently this event has a hint characteristic: a client can only be expected to make a 'best effort' in honouring individual capabilities but there are no guarantees.\nOnly changed capabilities need to be included, all other capabilities keep their values.",
"description": "The event indicates that one or more capabilities have changed.\nSince the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late).\nConsequently this event has a hint characteristic: a client can only be expected to make a 'best effort' in honoring individual capabilities but there are no guarantees.\nOnly changed capabilities need to be included, all other capabilities keep their values.",
"properties": {
"event": {
"type": "string",
Expand Down Expand Up @@ -678,7 +678,7 @@
"properties": {
"areas": {
"type": "array",
"description": "Set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honouring the areas but there are no guarantees. If this property is missing, empty, or if values are not understood, the client should assume a single value `all`.",
"description": "Set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honoring the areas but there are no guarantees. If this property is missing, empty, or if values are not understood, the client should assume a single value `all`.",
"items": {
"$ref": "#/definitions/InvalidatedAreas"
}
Expand Down
6 changes: 3 additions & 3 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ The `cancel` request is used by the client in two situations:
- to indicate that it is no longer interested in the result produced by a specific request issued earlier
- to cancel a progress sequence. Clients should only call this request if the corresponding capability `supportsCancelRequest` is true.

This request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honouring this request but there are no guarantees.
This request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honoring this request but there are no guarantees.

The `cancel` request may return an error if it could not cancel an operation but a client should refrain from presenting this error to end users.

Expand Down Expand Up @@ -586,7 +586,7 @@ The event indicates that one or more capabilities have changed.

Since the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late).

Consequently this event has a hint characteristic: a client can only be expected to make a 'best effort' in honouring individual capabilities but there are no guarantees.
Consequently this event has a hint characteristic: a client can only be expected to make a 'best effort' in honoring individual capabilities but there are no guarantees.

Only changed capabilities need to be included, all other capabilities keep their values.

Expand Down Expand Up @@ -736,7 +736,7 @@ interface InvalidatedEvent extends Event {
/**
* Set of logical areas that got invalidated. This property has a hint
* characteristic: a client can only be expected to make a 'best effort' in
* honouring the areas but there are no guarantees. If this property is
* honoring the areas but there are no guarantees. If this property is
* missing, empty, or if values are not understood, the client should assume
* a single value `all`.
*/
Expand Down

0 comments on commit 1f0a81b

Please sign in to comment.