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

WRP-539: Update handle docs to remove bindAs example #3170

Closed
wants to merge 1 commit into from

Conversation

seunghoh
Copy link
Member

Checklist

  • I have read and understand the contribution guide
  • A CHANGELOG entry is included
  • At least one test case is included for this feature or bug fix
  • Documentation was added or is not needed
  • This is an API breaking change

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]

Since bindAs is for internal use and doesn't export

Enact-DCO-1.0-Signed-off-by: Seungho Park <[email protected]>
@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (9cc6ea9) 82.21% compared to head (a6929b4) 82.21%.

❗ Current head a6929b4 differs from pull request most recent head 972ea60. Consider uploading reports for the commit 972ea60 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3170   +/-   ##
========================================
  Coverage    82.21%   82.21%           
========================================
  Files          155      155           
  Lines         7141     7141           
  Branches      1885     1885           
========================================
  Hits          5871     5871           
  Misses         997      997           
  Partials       273      273           
Files Changed Coverage Δ
packages/core/handle/handle.js 88.63% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@seunghoh seunghoh mentioned this pull request Aug 24, 2023
5 tasks
@seunghoh
Copy link
Member Author

Discussed and decided WNF

@seunghoh seunghoh closed this Aug 24, 2023
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.

1 participant