search

microbit-foundation / python-editor-v3

Micro:bit Educational Foundation Python Editor V3
https://python.microbit.org
MIT License
58 stars 37 forks source link

Mangled text in API docs for radio.receive #720

Open microbit-matt-hillsdon opened 2 years ago

microbit-matt-hillsdon commented 2 years ago

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 commented 2 years ago

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