docs: Update data logging. #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@microbit-mark this is ready for review and merge, which should update upstream PR bbcmicrobit#720. |
microbit-carlos
changed the title
microbit-carlos
force-pushed
the
datalog
branch
from
8da4ce9 to
ecaa719
Compare
docs/log.rst
Outdated
| flash storage. If set to ``False`` it uses a "fast" method, | ||
| which invalidates the data instead of performing a slower | ||
| full erase. | ||
| There are two erase modes, "full" completely removes the data from the |
There was a problem hiding this comment.
I wonder if this is more explicit about the two modes?
Suggested change
| There are two erase modes, "full" completely removes the data from the | |
| There are two erase modes; "full" completely removes the data from the physical storage and "fast" which invalidates the data without removing it from the storage. |
docs/log.rst
Outdated
| add(key=value) | ||
|
|
||
| There are two ways to add a data row into the log: | ||
| :param full: ``True`` selects a "full erase" and ``False`` selects the |
There was a problem hiding this comment.
Rather than having quote marks for "full erase", just quote the mode names "full" and "fast" as it will be more consistent in help docs
Suggested change
| :param full: ``True`` selects a "full erase" and ``False`` selects the | |
| :param full: ``True`` selects a "full" erase and ``False`` selects the "fast" erase method. |
|
Thanks Mark! Implemented the comments in e8069e4 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@microbit-mark FYI I'll be adding some updates to the datalog docs here (a PR to your fork), once it's ready we can merge it and the upstream PR will be updated and ready for merge into the upstream v2-docs branch.
First commit is just formatting right now, will add more things later.