search

timotheus / ebaysdk-python

eBay API SDK for Python
https://developer.ebay.com/tools/sdks
Other
809 stars 326 forks source link

Fix compatibility spelling error in yaml setting for Trading API #336

Closed michaelbutler closed 2 years ago

michaelbutler commented 4 years ago

I noticed the example yaml settings file ebay.yaml had a misspelling of compatibility (compatability). The python source code was actually looking for the correct spelling (compatibility), which means if anyone had the misspelled version, it would not read it and just default to whatever the python source default was, which looks to be currently 837.

With this PR I fixed the spelling in the yaml file, which should be safe and recommended for any new people to start using it.

Additionally, a bit less safe, I updated one part of the code that reads this to look for the misspelled (legacy) word, to use as the setting which it will use if the yaml does not contain compatibility. What affect will this have? Basically, for people who previously were using 837 "by accident" they will start using 719 if they update this package and they happened to keep the misspelling as-is.

Let me know if you want to just update the YAML file and nothing else!

michaelbutler commented 4 years ago

One thing, I didn't actually test this! Related, do unit tests run on pull requests on this repo? For example, travis-ci, circle-ci, or github actions. I don't see anything happening on them. It would be good to get that going so when changes are made we can visually assert that everything is passing. Let me know if you want some help with getting that set up.