add docs page for container index

NeurodataWithoutBorders · Sep 3, 2024 · 46059f7 · 46059f7
1 parent 1a67791
commit 46059f7
Showing 1 changed file with 6 additions and 1 deletion.
diff --git 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
  *