adafruit / Adafruit_CircuitPython_BME280

CircuitPython driver for the BME280
MIT License
63 stars 42 forks source link

Update auto build, turn on lint and make lint pass. #3

Closed tannewt closed 6 years ago

tannewt commented 6 years ago

This changes the attribute seaLevelhPa to sea_level_pressure to match python naming standards.

tdicola commented 6 years ago

FYI this is an API breaking change to modify the property name. Be sure to also update the guide here and its written up example of usage (including new screenshots): https://learn.adafruit.com/adafruit-bme280-humidity-barometric-pressure-temperature-sensor-breakout/downloads?view=all#circuitpython-test If you're changing other libraries and their properties consult their guides as many of them are written with the current properties. IMHO I would separate out making API breaking changes into separate pulls and releases so it's more obvious to someone that the library changed in a breaking way.

tannewt commented 6 years ago

Ok, will do. Thanks for the heads up.

I've got a PR (https://github.com/adafruit/cookiecutter-adafruit-circuitpython/pull/6) out to update cookiecutter so any new libraries will break upon misnaming and other lint errors.

@jwcooper can we get a REPL (green on black or similar) styled code block so that we don't need to use immutable screenshots?

tdicola commented 6 years ago

Double check with @ladyada as we explicitly changed to add screenshots vs. code blocks for guides. If you have mu and it works that would be even better and preferred (my version sadly still doesn't work).

tannewt commented 6 years ago

@tdicola What was the motivation?

tdicola commented 6 years ago

I assume to show people exactly what to expect, this was an example of the preferred output: https://learn.adafruit.com/adafruit-pcf8523-real-time-clock/rtc-with-circuitpython#setting-the-time

ladyada commented 6 years ago

yep - screenshots keep us honest :D

kattni commented 6 years ago

Tested by @jerryneedell successfully. Merging.