Documentation Updates (mcu.delay() and Design Guide) #481
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/docs/design_guide: added links to firmware build learning guides for SAMD21 & ESP8266. Changes were placed in the "Adding native modules" section, since that seemed to me the best place based on target audience.
docs/design_guide: fixed rst formatting for added firmware build links.
docs/design_guide: ACTUALLY fixed rst formatting for added links to firmware build guides
docs/design_guide: finalized layout and formatting of Build Firmware Learning Guide links.
shared-bindings/microcontroller/__init__.c: updated documentation for `delay()` per issue adafruit#243.
tannewt
requested changes
Dec 14, 2017
| //| `while` loop that runs for the specified `(delay)` time. If you have other | ||
| //| code or peripherals that require specific timing or processing while you are waiting, | ||
| //| explore a different avenue such as using `time.monotonic()` to evaluate time | ||
| //| in a loop. |
There was a problem hiding this comment.
Audio recording is one example that will not run during delay_us. You can also point to time.sleep as an alternative for longer delays because it will actually use something like time.monotonic to do some things in the background while waiting.
There was a problem hiding this comment.
Alright. I wasn't sure if time.sleep caused the same behavior or not.
| `SAMD21 - Build Firmware Learning Guide <https://learn.adafruit.com/micropython-for-samd21/build-firmware>`_ | ||
|
|
||
| `ESP8266 - Build Firmware Learning Guide <https://learn.adafruit.com/building-and-running-micropython-on-the-esp8266/overview>`_ | ||
|
|
There was a problem hiding this comment.
This is a great place for these!
shared-bindings/microcontroller/__init.c__: updated `delay()` documentation based on reviewer's (@tannewt) suggested changes.
shared-bindings/microcontroller: fixed sphinx formatting
tannewt
approved these changes
Dec 14, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
shared-bindings/microcontroller/init.c: updated documentation for
delay(), per issue #243.docs/design_guide: added links to learning guides for building firmware (SAMD21 & ESP8266).