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

Improve documentation for TaskAPI #8695

Merged
merged 1 commit into from
Nov 6, 2020

Conversation

tortmayr
Copy link
Contributor

@tortmayr tortmayr commented Nov 2, 2020

Fixes #8694
Signed-off-by: Tobias Ortmayr [email protected]
Contributed on behalf of STMicroelectronics

What it does

Adds/refines documentation for components of the Task API.

How to test

Documentation changes only

Review checklist

Reminder for reviewers

@vince-fugnitto vince-fugnitto added documentation issues related to documentation tasks issues related to the task system labels Nov 2, 2020
Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I verified the content and it looks good 👍 I have some comments however:

packages/task/src/browser/task-contribution.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-runner.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-runner.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-runner.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-runner.ts Outdated Show resolved Hide resolved
@tortmayr tortmayr force-pushed the task branch 3 times, most recently from f53cfb3 to fb3dd77 Compare November 4, 2020 11:03
@tortmayr
Copy link
Contributor Author

tortmayr commented Nov 4, 2020

Thanks for the fast review. I applied your feedback suggestions.

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tortmayr the changes look good, the only thing to address are the typos and missing punctuation.

packages/task/src/node/task-runner.ts Outdated Show resolved Hide resolved
packages/task/src/browser/task-contribution.ts Outdated Show resolved Hide resolved
packages/task/src/browser/task-contribution.ts Outdated Show resolved Hide resolved
packages/task/src/browser/task-contribution.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
packages/task/src/node/task-manager.ts Outdated Show resolved Hide resolved
Fixes eclipse-theia#8694
Signed-off-by: Tobias Ortmayr <[email protected]>
Contributed on behalf of STMicroelectronics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation tasks issues related to the task system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for Task API
2 participants