Fix precallPermissionsHelpLink attribute name#64
Open
amureki wants to merge 3 commits into
Open
Conversation
The documentation is not aligned with the actual SDK key: https://github.com/whereby/sdk/blob/e6e413fb31aab6241faf8a8e62e96bc4f3c69a47/packages/browser-sdk/src/lib/embed/index.ts#L51 Doc says "precallPermissionHelpLink" (singular permission) instead of "precallPermissionsHelpLink" (plural permissions). This change aligns the docs with the actual implementation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The web component uses
precallPermissionsHelpLinkwith pluralPermissions:However, the documentation page uses singular version:
https://docs.whereby.com/reference/using-the-whereby-embed-element#attributes-of-the-component
This PR updates the docs from
precallPermissionHelpLinktoprecallPermissionsHelpLinkso the documented attribute matches the Browser SDK implementation and TypeScript definitions.