campaignmonitor / createsend-python

A Python library for the Campaign Monitor API
http://campaignmonitor.github.io/createsend-python
MIT License
57 stars 64 forks source link

Minor changes to consent_to_track & README.md #63

Closed xfxf closed 6 years ago

xfxf commented 6 years ago

As per issue #62 - allowed consent_to_track parameter to be a boolean, and added info near the top of the README.md which should hopefully help people who upgrade their libraries and find that the API has broken.

I went to add tests, but notice the existing tests don't particularly lend theirselves to testing this (and there aren't any for consent_to_track functionality at the moment). I can add them if needed, but I manually tested this in Python 2.7, Python 3.4 & Python 3.6 and all works as expected.

coveralls commented 6 years ago

Coverage Status

Coverage increased (+2.4%) to 98.806% when pulling 35ce786f5fd61021cbeab0672552381bc8abbe2b on xfxf:master into 4bfe2fd5cb2fc9d8f12280b23569eea0a6c66426 on campaignmonitor:master.

coveralls commented 6 years ago

Coverage Status

Coverage decreased (-0.3%) to 96.186% when pulling dc1bcce6be1c9c9e854cf36251b1ed894c730adc on xfxf:master into 4bfe2fd5cb2fc9d8f12280b23569eea0a6c66426 on campaignmonitor:master.

xfxf commented 6 years ago

@katharosada I'm going to close this; with reflection this API change is confusing (it can now take 6 values, 3 of which are the same) and given this is a breaking change across all libraries, it's not a problem that is particularly unique to this implementation nor deserves to be at the top of the README.md.