WRP-539: Update handle docs to remove bindAs example #3170
Closed
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.
Checklist
Issue Resolved / Feature Added
bindAs
utility is for internal use only and is not exported but docs example uses.It could cause confusion for readers.
Resolution
Removed
bindAs
usage from the example and added some inline comments for internal developers about the handle.bindAs purpose.Additional Considerations
I still don't know if we need to export
bindAs
function to the public. This function is definitely useful.If we decide to make it public, we shall add docs, example.
Links
WRP-539
#1652
Comments
Enact-DCO-1.0-Signed-off-by: Seungho Park [email protected]