Update ArrayParameter Docs #2126
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #2126 +/- ##
=======================================
Coverage 71.24% 71.24%
=======================================
Files 151 151
Lines 20150 20150
=======================================
Hits 14356 14356
Misses 5794 5794 |
astafan8
requested changes
Aug 21, 2020
| @@ -150,7 +150,7 @@ | |||
| "\n", | |||
| "We have kept the documentation shown below of `ArrayParameter` for the legacy purpose.\n", | |||
| "\n", | |||
| "For actions that create a whole array of values at once. When you use it in a `Loop`, it makes a single `DataArray` with the array returned by `get` nested inside extra dimension(s) for the loop.\n", | |||
| "For actions that create a whole array of values at once. When you use it in a `Loop`, it makes a single `DataArray` with the array returned by `get` nested inside extra dimension(s) for the loop. While storing this single `DataArray` in the database using `datasaver.add_result()` , be informed that it is stored as BLOB in one row of sqlite database. Where the BLOB in sqlite has a default max length limit set at 1 billion (1,000,000,000) bytes. \n", | |||
There was a problem hiding this comment.
@Akshita07 Loop is a legacy feature of qcodes that does not use the sqlite database, so this "note" should not refer to the Loop.
(i'd also suggest to make it a separate paragraph so that it does not blend with the rest of the text)
| @@ -150,7 +150,7 @@ | |||
| "\n", | |||
| "We have kept the documentation shown below of `ArrayParameter` for the legacy purpose.\n", | |||
| "\n", | |||
| "For actions that create a whole array of values at once. When you use it in a `Loop`, it makes a single `DataArray` with the array returned by `get` nested inside extra dimension(s) for the loop.\n", | |||
| "For actions that create a whole array of values at once. When you use it in a `Loop`, it makes a single `DataArray` with the array returned by `get` nested inside extra dimension(s) for the loop. While storing this single `DataArray` in the database using `datasaver.add_result()` , be informed that it is stored as BLOB in one row of sqlite database. Where the BLOB in sqlite has a default max length limit set at 1 billion (1,000,000,000) bytes. \n", | |||
There was a problem hiding this comment.
and we need the same/similar kind of note in the "paramtypes explained notebook".
astafan8
approved these changes
Aug 21, 2020
Akshita07
force-pushed
the
updateArrayParameterDoc
branch
from
5bb7193 to
b5459ee
Compare
astafan8
approved these changes
Aug 21, 2020
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.
Fixes #1440
Changes proposed in this pull request:
@astafan8