-
Notifications
You must be signed in to change notification settings - Fork 7
working library & example #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
maybe we want to add |
|
i give up. code works, will figure out why travis is failing later |
We've had the discussion of adding the Blinka/PyPI stuff to cookiecutter. Just need to narrow down everything that should/can be included and how to handle the
Looks like it's failing to build rpi-ws281x: Looks like the same error reported in rpi-ws281x issue #12. |
|
yeah i need to figure out how to not install that on travis, but do install it on raspi only |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! A few nit-noid things...
Also, I may change the VEML6070 library to match this. I wrote it without the use of @property and setter structure...
adafruit_veml6075.py
Outdated
| # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| # THE SOFTWARE. | ||
| """ | ||
| `Adafruit_VEML6075` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs to match the filename's case: `adafruit_veml6075`
docs/conf.py
Outdated
| # Uncomment the below if you use native CircuitPython modules such as | ||
| # digitalio, micropython and busio. List the modules you use. Without it, the | ||
| # autodoc module docs will fail to generate with a warning. | ||
| # autodoc_mock_imports = ["digitalio", "busio"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will need to uncomment, and mock micropython.
adafruit_veml6075.py
Outdated
| @integration_time.setter | ||
| def integration_time(self, val): | ||
| """Set how long the VEML samples data. | ||
| Can be 50, 100, 200, 400 or 800ms""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most other libraries only have the docstring in the @property function. RTD may render integration_time twice or combine them, which could be confusing. I would just add something like, "Valid times are: 50, 100, 200, 400, or 800" to the end of the @property docstring.
Although, after reviewing a couple other doc pages, maybe we should start/change the docstrings to include the setter functions. As they stand, the API documentation does not show the available args. This may be a good in-the-weeds topic for the meeting on Monday though. Thoughts @kattni @tannewt?
README.rst
Outdated
| Usage Example | ||
| ============= | ||
|
|
||
| .. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Travis will flag this .. todo.
|
@sommersoft great review, thanks - i fixed all the simple things up. |
|
np! you even fixed one |
|
whew finally travis passes - take a look! hardware coming soon but this library can be released now :) |
|
thanks! mergin, @tannewt - lemme know if you have any changes, we wont be releasing this sensor for a week or two |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
seems to work, will take it outside to the daystar tomorrow