v1.5 release #727
v1.5 release #727
Conversation
Fix all the missing links found, expand some examples, tidy up diagrams, structure some of the chapters a bit better (regular vs base classes in the API reference). No code changes in this commit; it's all docs.
A little more docs work, plus tidying up the code to match the freshly fixed docs (e.g. all devices, including internal, should have a pin_factory arg in their constructor). Make a vague attempt to appease pylint with some line-length fixes; I don't think it's going to be terribly useful yet though...
The class hierarchies are a bit messy; some things appear in the OutputDevices page which don't actually descend from OutputDevice (like Motor) because they're multi-pin composite devices, but we want to present them as something relatively simple for the sake of younger programmers.
Codecov Report
@@ Coverage Diff @@
## master #727 +/- ##
==========================================
- Coverage 79.13% 79.08% -0.05%
==========================================
Files 22 22
Lines 4352 4361 +9
Branches 634 638 +4
==========================================
+ Hits 3444 3449 +5
- Misses 855 856 +1
- Partials 53 56 +3
Continue to review full report at Codecov.
|
Just to make the diffs of the generated .dot files easier to read.
We're not doing copyright attribution for contributors because frankly we haven't been doing it so far and it'd be a right pain to start now. So "Ben and contributors" it is. I'll fill out the license headers in a bit.
And add a Makefile target for it, and some notes in the docs clarifying that contributors retain their copyrights.
And ignore some other useless build artifacts
|
Thanks @waveform80 looking great. I've added a todo list to the top of this PR (which is just a merge request for the docs-tidy-up branch). I think all that's missing now is #630 and your |
|
@waveform80 sorry hadn't seen your tones branch, I've created PR #729. Are you happy with it? I will give it some testing with JamHat. Looks great though! |
|
If @waveform80 has time, I think it would be nice if #718 (comment) got fixed for v1.5 too, i.e. add a background thread so that the 'events' fire for InternalDevices. AIUI if the example shown at https://gpiozero.readthedocs.io/en/stable/api_other.html#gpiozero.TimeOfDay was changed slightly to: from gpiozero import TimeOfDay, Energenie
from datetime import time
from signal import pause
lamp = Energenie(0)
morning = TimeOfDay(time(7), time(8))
morning.when_activated = lamp.on
morning.when_deactivated = lamp.off
pause()then the lamp wouldn't turn on and off as you might expect it to. (although I've not written or run any GpioZero code for ages, so if that does work already then please ignore me and accept my apologies!) |
|
@lurch you are correct, it's still broken. However we are on the brink of a release (probably tomorrow) and I think we agreed to leave it to v1.6. Perhaps if it's easy enough we can fix it and pop into a 1.5.1 release? |
Yeah - it would be lovely, but I've already delayed this release enough as it is. I'll try and get that into a 1.5.1 as Ben suggests as it's a major deficiency in the current API. |
Hmmm ... good point. pi_info() should probably be calling _default_pin_factory - although that's a little dirty - I wonder if there's a "cleaner" way ... |
Ahhh, I've not been keeping up with things and didn't realise the release was so imminent 🙂 |
|
Ticked but issue open = done but unmerged |
|
P.S. I dunno what's going on with GH not showing the associated code next to my review comments above :-( |
| @@ -32,13 +32,14 @@ Release 1.5.0 (2019-02-01) | |||
| `#634`) | |||
There was a problem hiding this comment.
Is there an underscore missing after 634 ?
There was a problem hiding this comment.
Looks like it - feel free to push little fixes like that when you see them (if you have time).
The method of constructing Device.pin_factory has changed; it is no longer implicit upon import which means pinout needs to move where it tests for the inability to construct it (when run on a PC with no explicit mock settings)
TODO:
TonalBuzzerAPI (done, unmerged)JamHat.off()turn the buzzer off?