Merged
Conversation
The following commit updates the documentation for `ProgressMessageOptions.cancelable` which was not updated when we introduced a breaking change. Signed-off-by: vince-fugnitto <vincent.fugnitto@ericsson.com>
paul-marechal
approved these changes
Feb 5, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What it does
The following pull-request fixes a documentation issue caused by the breaking changes of #8479.
The following commit updates the default value documentation for
ProgressMessageOptions.cancelablewhich wasnot updated when we introduced a breaking change. This change was caught by a downstream theia extension who noticed the breaking changes, and the documentation was incorrect.
Alternatively, we could have updated the default on the plugin-side to support vscode, and not break our downstream extensions.
How to test
Verify that the documentation now accurately reflects the changes present in #8479.
Namely:
theia/packages/core/src/common/message-service-protocol.ts
Lines 54 to 59 in b74355f
Review checklist
Reminder for reviewers
Signed-off-by: vince-fugnitto vincent.fugnitto@ericsson.com