Skip to content

docs: Update data logging. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 23, 2022
Merged

docs: Update data logging. #1

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e6bac6
docs: Fix formatting for log docs.
microbit-carlos Mar 16, 2022
c6ee83f
docs: Update data logging content.
microbit-carlos Mar 21, 2022
ecaa719
docs: Move log.rst code into a script in the examples folder.
microbit-carlos Mar 21, 2022
e8069e4
docs: Update with review comments.
microbit-carlos Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs: Update with review comments.
  • Loading branch information
@microbit-carlos
microbit-carlos committed Mar 22, 2022
commit e8069e41d1ad1822889d947f5a3e4453d2b8c716
8 changes: 4 additions & 4 deletions docs/log.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ Functions
To add the log headers again the ``set_labels`` function should to be
called after this function.

There are two erase modes, "full" completely removes the data from the
physical storage, and the "fast" method only invalidates the data.
There are two erase modes; "full" completely removes the data from the
physical storage, and "fast" invalidates the data without removing it.

:param full: ``True`` selects a "full erase" and ``False`` selects the
"fast erase" method.
:param full: ``True`` selects a "full" erase and ``False`` selects the
"fast" erase method.

.. py:function:: add( data_dictionary, /, *, **kwargs)

Expand Down