From 46059f78cbe572f505e199cbbb8190b7ef1ad6c7 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Tue, 3 Sep 2024 10:55:22 -0700 Subject: [PATCH] add docs page for container index --- docs/pages/userdocs/workflow.dox | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/pages/userdocs/workflow.dox b/docs/pages/userdocs/workflow.dox index 470442aa..106f46ff 100644 --- a/docs/pages/userdocs/workflow.dox +++ b/docs/pages/userdocs/workflow.dox @@ -57,7 +57,12 @@ * Next, create the different data types (e.g. \ref AQNWB::NWB::ElectricalSeries "ElectricalSeries" * or other AQNWB::NWB::TimeSeries "TimeSeries") that you would like to write data into. After * creation, these objects are added to the \ref AQNWB::NWB::RecordingContainers "RecordingContainers" - * object so that it can manage access and data writing during the recording process. + * object so that it can mana ge access and data writing during the recording process. + * When adding containers, ownership of the \ref AQNWB::NWB::Container "Container" is transferred to the + * \ref AQNWB::NWB::RecordingContainers "RecordingContainers" object, so that we can access it again via + * its index. New containers will always be appended to the end of the + * \ref AQNWB::NWB::RecordingContainers::containers "containers" object and their index can be tracked + * using the size of the input `recordingArrays`. * * \snippet tests/examples/testWorkflowExamples.cpp example_workflow_datasets_snippet *