Skip to content

Commit

Permalink
clarify dynamictable tutorial (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
bendichter committed Nov 10, 2020
1 parent 1cf4f7c commit b2509e6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/gallery/dynamictable.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@
# with a ragged array column, pass both
# the :py:class:`~hdmf.common.table.VectorIndex` and its target
# :py:class:`~hdmf.common.table.VectorData` object in for the ``columns``
# argument in the constructor.
# argument in the constructor. For instance, the following code creates a column
# called ``col1`` where the first cell is ['1a', '1b', '1c'] and the second cell
# is ['2a'].

col1 = VectorData(
name='col1',
Expand All @@ -145,7 +147,9 @@
columns=[col1, col1_ind],
)

###############################################################################
####################################################################################
# VectorIndex.data provides the indices for how to break VectorData.data into cells
#
# You can add a ragged array column to an existing
# :py:class:`~hdmf.common.table.DynamicTable` by specifying ``index=True``
# to :py:meth:`DynamicTable.add_column <hdmf.common.table.DynamicTable.add_column>`.
Expand Down

0 comments on commit b2509e6

Please sign in to comment.