Fix ActionServer cancelCallback declaration, doc & test #867
Conversation
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
minggangw
approved these changes
Jul 23, 2022
Member
minggangw
left a comment
minggangw
left a comment
There was a problem hiding this comment.
Thanks for updating the doc & examples, LGTM!
| * @param cancelCallback - Callback function, if not provided, then unregisters any previously registered callback. | ||
| */ | ||
| registerCancelCallback(cancelCallback?: CancelCallback): void; | ||
| registerCancelCallback(cancelCallback?: CancelCallback<T>): void; |
Member
There was a problem hiding this comment.
Optional param makes sense, thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
While the ActionServer implementation will pass it's CancelCallback function a ServerGoalHandler argument, this fact is not clearly documented, not illustrated in the actionserver tests and the TS CancelCallback function declaration does not include a ServerGoalHandle parameter.
This PR updates docs, test suite and modifies the TypeScript CancelCallback function declaration to include a required ServerGoalHandle parameter. The change breaks existing TypeScript ActionServers that implement a custom CancelCallback function with a compilation error.
Question: To make this a non-breaking change we can make the ServerGoalHandle optional. Thoughts?
Fix #866