Minimal examples for almost every API call #31
Merged
Conversation
This file contains 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
We'll try out displaying these and see what folks think.
microbit-matt-hillsdon
force-pushed
the
examples
branch
from
ae663c2 to
4d2dac0
Compare
microbit-matt-hillsdon
changed the title
…-microbit-stubs into examples
Also spotted a send vs send_bytes error in radio.
…ython-microbit-stubs into test
|
Updated the editor PR with changes to 0ec829d in microbit-foundation/python-editor-v3@3339392 |
|
@microbit-matt-hillsdon This all looks good, and I'm happy to approve, unless you wanted to wait for further input on the i2c, uart and spi modules? |
I have some comments from Carlos re i2c to incorporate but I'll track that separately as realistically most of the value is from the more commonly used APIs. Raised #34 Thanks for the review. |
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.
I kept them very concise.
I didn't worry about them generating output (e.g. using print or display.scroll all over the place).
I didn't give examples where there wasn't anything to add, e.g. for
temperature()(on the assumption folks are using `from microbit import * as our docs recommend).I have written examples for e.g.
display.read_light_level()on the basis that having thedisplay.is useful. I'm not so sure that this was worthwhile and am considering removing them. You encounter them via autocomplete or signature help, in which case you have thedisplayby definition, or in the V3 Python editor API docs, which could chose to makedisplay.clearer in some other way. It feels like repetition there at the moment. See the preview: https://review-python-editor-next.microbit.org/examples/I haven't attempted to use return values, with one exception. I've unpacked tuples where a small fixed number of values are returned, e.g.
x, y, z = accelerometer.get_values(). This seems worthwhile to me as if you miss that then the return value is harder to work with.I'd appreciate input on the i2c, uart and spi modules with a view to making the examples more meaningful if we can (e.g. a real accessory init line).
Outstanding queries/feedback:
Raised #33 which was spotted along the way.