search

adafruit / Adafruit_CircuitPython_asyncio

CIrcuitPython subset of CPython asyncio library
MIT License
28 stars 16 forks source link

Add docstrings #19

Closed tekktrik closed 2 years ago

tekktrik commented 2 years ago

Resolves #17 by adding docstring documentation, also updates supporting files so that Sphinx will build and show them as documentation.

tekktrik commented 2 years ago

Looks like the asyncio.stream.py has a bunch of yields and returns mixed together, so I can hold off until it's possible for a single commit fix or workaround for them as opposed to doing it one by one

tekktrik commented 2 years ago

Hey @dhalbert, any update on this? I know you're working on asyncio stuff so just wanted to check how this fits in, or if I should expect to update it as you make changes.

dhalbert commented 2 years ago

I think we can proceed on this. It looks like you found the places to change from yield. There are going to be some more changes re #22 but I don't think I will do that immediately.

tekktrik commented 2 years ago

Sounds good, here it is, ready for review! Let me know if I can help document any additional changes!

dhalbert commented 2 years ago

Could you test at least some of the examples in the async guide: https://learn.adafruit.com/cooperative-multitasking-in-circuitpython with these changes? Thanks! I will take a final look after that.

FoamyGuy commented 2 years ago

I will test the learn guide examples with this branch in the afternoon after the weekly meeting.

FoamyGuy commented 2 years ago

I tested many of the examples from the learn guide using a Feather RP2040 with some LEDs and buttons wired up. For the neopixel rainbow animation one I used a NeoTrellis and slightly modified the code to read from one row of the matrix.

Everything appears to be functioning as expected.

Ready for review when you have time @dhalbert

tekktrik commented 2 years ago

@dhalbert is this still good to go? Looks like it passed the hardware check.