Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core: fix progress documentation #9033

Merged
merged 1 commit into from
Feb 5, 2021
Merged

core: fix progress documentation #9033

merged 1 commit into from
Feb 5, 2021

Conversation

vince-fugnitto
Copy link
Member

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.cancelable which was
not 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:

export namespace ProgressMessage {
export const Cancel = 'Cancel';
export function isCancelable(message: ProgressMessage): boolean {
return !!message.options?.cancelable;
}
}

Review checklist

Reminder for reviewers

Signed-off-by: vince-fugnitto [email protected]

The following commit updates the documentation for `ProgressMessageOptions.cancelable` which was
not updated when we introduced a breaking change.

Signed-off-by: vince-fugnitto <[email protected]>
@vince-fugnitto vince-fugnitto added documentation issues related to documentation messaging issues related to messaging labels Feb 5, 2021
@vince-fugnitto vince-fugnitto self-assigned this Feb 5, 2021
@paul-marechal paul-marechal merged commit 27e6ea7 into master Feb 5, 2021
@github-actions github-actions bot added this to the 1.11.0 milestone Feb 5, 2021
@paul-marechal paul-marechal deleted the vf/progress-docs branch February 5, 2021 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation messaging issues related to messaging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants