Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Confusing Documentation on Github Readme
See original GitHub issueThe documentation available on the readme is very confusing.
For example, after setting up proper authentication, the first example presented is:
shop = shopify.Shop.current()
In the rest of the example the variable shop is never used and there’s no explanation of what this line does or why it’s necessary (is it necessary?)
Additionally it’s stated that everything is returned as an ActiveResource, with no explanation of what that is, what it offers, or how it affects how the api should be used.
For many, this README is the first and only point of information for usage of this library, and some more clarity in the documentation would go a long way. Please consider revamping the README so us shopify newbies can get up to speed faster 😄
Right now I’m balancing whether I’d rather read the code to figure this out or open source an easier to use api.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:3
- Comments:8 (3 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
Fortunately Dropbox Paper can convert into markdown! File attached.
Shopify-Python-API-Cheatsheet.md.zip
Looks pretty good! I would be happy to merge something like this to a markdown file in the repo