microbit-foundation / python-editor-v3

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

[Data logging] Default in API docs for log.set_labels timestamp parameter should be SECONDS not MILLISECONDS #920

Closed microbit-matt-hillsdon closed 2 years ago

microbit-matt-hillsdon commented 2 years ago

Spotted by Rob reviewing the simulator work.

The default for the log.set_labels timestamp parameter should be SECONDS not MILLISECONDS.

The behaviour is correct, just the docs/stubs that are misleading.

microbit-matt-hillsdon commented 2 years ago

Note docs for data logging aren't merged at the time of writing - see https://github.com/bbcmicrobit/micropython/pull/720 (this may change soon).

microbit-robert commented 2 years ago

Our example for log.set_labels should use a keyword argument to set the timestamp. See example and conflicting docs below:

image