python-editor-v3 icon indicating copy to clipboard operation
python-editor-v3 copied to clipboard

Mangled text in API docs for radio.receive

Open microbit-matt-hillsdon opened this issue 3 years ago • 1 comments
trafficstars

image

The docstring might require escaping? It's obviously not helpful to try to render \x0. Need to check the rules. I also don't entirely trust the restructured text -> markdown conversion that's going on. Could also reword in desperation 😄

    Equivalent to ``str(receive_bytes(), 'utf8')`` but with a check that the the first
    three bytes are ``b'\x01\x00\x01'`` (to make it compatible with other platforms that
    may target the micro:bit).

Screenshot taken on Windows (in case rendering differs).

microbit-matt-hillsdon avatar Apr 29 '22 15:04 microbit-matt-hillsdon

Text isn't in first line so no need to look at this for strings freeze.

microbit-matt-hillsdon avatar Jul 13 '22 09:07 microbit-matt-hillsdon