docs: Update README so the example works verbatim #779
Conversation
This file contains 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
The import was missing curly braces, and it was importing the wrong thing which led to the example failing, as also described in appium#649 that was closed by the author without sending a PR. I thought the library code might have changed and/or the README had got out of sync, but after looking at the source I realised what was happening. This little change helps people get started with the lib. Hope it helps!
Update README.md so the example works
|
Thank you @sole |
sole
changed the title
sole
changed the title
|
Thank you - I wasn't sure if you needed the CLA for a doc change. I hope the new PR title is OK now, let me know what exactly to use otherwise because the feedback of the action is non-existent other than 'failing' :-) |
mykola-mokhnach
approved these changes
Jan 2, 2025
|
🎉 This PR is included in version 12.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 import was missing curly braces, and it was importing the wrong thing which led to the example failing, as also described in #649 that was closed by the author without sending a PR.
I thought the library code might have changed and/or the README had got out of sync, but after looking at the source I realised what was happening.
This little change helps people get started with the lib. Hope it helps!