Test and documentation for save/load of external Sidre views. #1474
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
explain the process used
nselliott
added
Sidre
nselliott
requested review from
white238,
cyrush,
kennyweiss,
rhornung67,
gunney1 and
Arlie-Capps
white238
reviewed
Nov 15, 2024
| @@ -50,7 +50,23 @@ which omits error-checking and recovery for brevity and clarity. | |||
| The ``loadExternalData()`` method is used to read "external" data from an HDF5 | |||
| file created with the ``sidre_hdf5`` protocol. This is data referred to by | |||
| *external* views. Such views refer to data that is not stored in Sidre buffers | |||
There was a problem hiding this comment.
Wasnt from the PR but there is two differing ways to highlight "external" here... italicized and quoted.
white238
approved these changes
Nov 15, 2024
There was a problem hiding this comment.
Thanks for clarifying this @nselliott and more so helping me out the last couple days!
rhornung67
reviewed
Nov 18, 2024
| but it will *not* allocate storage or load data values for the views with | ||
| external data. Second, the calling code must provide each external ``View`` | ||
| a pointer to valid storage that will hold the external data, using | ||
| ``setExternalDataPtr()``. Finally, ``loadExternalData()`` is called, |
There was a problem hiding this comment.
Should a comment be added about describing the external data?
There was a problem hiding this comment.
There is no step needed to describe the external data when loading, as the first load() call restores the descriptions that were saved. I mention that here, but I could try to change the wording?
There was a problem hiding this comment.
I must have missed it. It may be good to emphasize the point in bold or similar so readers catch it.
rhornung67
approved these changes
Nov 18, 2024
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.
Summary
#if 0block. Here this test is fixed to do the right thing and includes a section to be used as a snippet in the sphinx docs.Based on recent conversations I realized that the process to save and load views with external data lacked sufficient documentation, and had no active test code for the serial case (i.e. not using SPIO). The process takes three steps and is not obvious. I found the inactive test code and revised it so that it works, and added an explanation to the sphinx docs.