search

bbcmicrobit / micropython

Port of MicroPython for the BBC micro:bit
https://microbit-micropython.readthedocs.io
Other
603 stars 284 forks source link

docs: Remove outdated mention to display.image. #739

Closed microbit-carlos closed 2 years ago

microbit-carlos commented 2 years ago

This was present in an old version of MicroPython and no longer available.

Review URL: https://microbit-micropython--739.org.readthedocs.build/en/739/microbit_micropython_api.html#images

microbit-carlos commented 2 years ago

@microbit-mark could you review once you get a chance? Thanks!

microbit-mark commented 2 years ago

The phrasing to describe each API and the styling seems inconsistent on the page

image

image

image

image

I suggest we use the accelerometer example for display and compass and say a bit more about the Image something like The Image API can be used with display and offers the following...

microbit-carlos commented 2 years ago

Thanks Mark! PR https://github.com/bbcmicrobit/micropython/pull/741 also touches some of this text, once we have these two PRs merged, could you raise a PR against master to suggest some wording?

microbit-carlos commented 2 years ago

As the comment is about future updates to the wording and this PR deletes outdated information I'll merge this now and we can create a new PR after the other (like https://github.com/bbcmicrobit/micropython/pull/748) are merged first.