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

Update withStripeTerminal variable reference link #797

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

tim-lin-bbpos
Copy link
Collaborator

Summary

Update withStripeTerminal variable reference link

Motivation

The line number in source code file is shifted since the code is rapidly evolved, update and also point to a range instead of single line for now.

The original reference should be: https://github.com/stripe/stripe-terminal-react-native/blame/a534b8f8efb42ec033c278c4058bcf8755d2abf2/src/hooks/useStripeTerminal.tsx#L51

Testing

  • I tested this manually
  • I added automated tests

Documentation

Select one:

  • I have added relevant documentation for my changes.
  • This PR does not result in any developer-facing changes.

README.md Outdated
@@ -154,7 +154,7 @@ export default function PaymentScreen() {
In case your app uses `React Class Components` you can use dedicated `withStripeTerminal` Higher-Order-Component.
Please note that unlike the hooks approach, you need to use event emitter to listen on specific events that comes from SDK.

[Here](https://github.com/stripe/stripe-terminal-react-native/blob/main/src/hooks/useStripeTerminal.tsx#L51) you can find the list of available events to be used within the event emitter.
[Here](https://github.com/stripe/stripe-terminal-react-native/blob/main/src/hooks/useStripeTerminal.tsx#L85-L109) you can find the list of available events to be used within the event emitter.
Copy link
Collaborator

Choose a reason for hiding this comment

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

thoughts on using the current latest commit instead of main in the url?

https://github.com/stripe/stripe-terminal-react-native/blob/281df38/src/hooks/useStripeTerminal.tsx#L85-L109

this will always link to what we intend to show and if things shift later users could be able to locate the new location based on example code

@nazli-stripe nazli-stripe merged commit ae14740 into main Sep 4, 2024
3 checks passed
@nazli-stripe nazli-stripe deleted the bbpos/update-react-class-component-doc branch September 7, 2024 17:15
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.

2 participants