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 #8

Closed
wants to merge 1 commit into from
Closed

Improve documentation for TaskAPI #8

wants to merge 1 commit into from

Conversation

tortmayr
Copy link

@tortmayr tortmayr commented Oct 1, 2020

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

Copy link
Member

@koegel koegel left a comment

Choose a reason for hiding this comment

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

Minor changes required

* @param provider the {@link TaskProvider} that should be registered
*
* @returns a `Disposable` that can be invoked to unregister the given resolver
*/wit
Copy link
Member

Choose a reason for hiding this comment

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

Code is broken here

registerRunner(runners: TaskRunnerRegistry): void;
}

export const TaskRunner = Symbol('TaskRunner');
/** A Task Runner knows how to run and kill a Task of a particular type. */
/**
* A {@link TaskRunner} knows how to run and kill a task of a particular type.
Copy link
Member

Choose a reason for hiding this comment

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

It does not know how to kill a task imho.

Copy link
Member

Choose a reason for hiding this comment

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

Comment still open

Copy link
Author

Choose a reason for hiding this comment

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

Fixed

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.ts Outdated Show resolved Hide resolved
@tortmayr
Copy link
Author

tortmayr commented Oct 5, 2020

Thanks for the fast review. I addressed the issues and squashed the changes into a single commit

@tortmayr tortmayr requested a review from koegel October 5, 2020 08:15
Copy link
Member

@koegel koegel left a comment

Choose a reason for hiding this comment

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

Open comment from last review

registerRunner(runners: TaskRunnerRegistry): void;
}

export const TaskRunner = Symbol('TaskRunner');
/** A Task Runner knows how to run and kill a Task of a particular type. */
/**
* A {@link TaskRunner} knows how to run and kill a task of a particular type.
Copy link
Member

Choose a reason for hiding this comment

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

Comment still open

Fixes eclipse-theia#8694
Signed-off-by: Tobias Ortmayr <[email protected]>
Contributed on behalf of STMicroelectronics
@sdirix
Copy link
Member

sdirix commented Nov 16, 2022

Merged upstream with eclipse-theia#8695

@sdirix sdirix closed this Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants