Documentation

[crablab]

Hey 👋

I note that this is missing Pydoc.

I'm happy to go through and add some if that would be useful? :)

[ladyada]

@tannewt hihi you're the documentation expert, whatcha think? :)

[tannewt]

@crablab What do you mean by Pydoc? It looks like the properties are documented: https://github.com/adafruit/Adafruit_CircuitPython_BME280/blob/master/adafruit_bme280.py#L295-L298

A PR to improve docs is always welcome!

[crablab]

Yeah, basically that but there are some places where it is missing and no explicit params or return values are supplied :)

eg.

Adafruit_CircuitPython_BME280/adafruit_bme280.py

Line 479 in 394cb7a

def __init__(self, i2c, address=_BME280_ADDRESS):

If contributions to docs are okay, maybe I can take a look through and update some of the comments and then PR it? You can then yay or nay it 😊

[tannewt]

@crablab Yup! All kinds of contributions are encouraged. Let me know if you need any help getting going. Most of the devs are available for questions on the Adafruit Discord too: https://adafru.it/discord

[evaherrada]

@crablab Hey, is this something you're still interested in doing? If not, that's totally fine

[crablab]

Hey! Sorry, I missed this 🙈 I'll have a look this weekend if that's okay?

[evaherrada]

@crablab No worries. This pr would be greatly appreciated, but don't feel obligated to work on it.

[crablab]

@dherrada For sure 😄 I'll update this at the weekend with what I have/haven't done to give you a steer! 😄

[jposada202020]

@crablab Hello, would you like to work on this 😄 I can take a look during this weekend if you want

[crablab]

@jposada202020 Feel free! :)

[evaherrada]

closed by #46