Skip to content

Commit

Permalink
docs: remove mention of the requirement to specify a "Name" for a cell
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjholland committed Jan 4, 2025
1 parent 314f0e9 commit cc1313f
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions docs/source/user_guide/importing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,8 @@ A cell object can be created by providing an info dictionary as a keyword argume
# Create a cell object
cell = pyprobe.Cell(info = info_dictionary)
The ``info`` dictionary can contain any number of key-value pairs. The only required key is
``'Name'``, which is used to identify the cell in plots. PyProBE will verify that the
``info`` dictionary contains the ``'Name'`` field. If it does not, it will fill this field with
``'Default Name'``.
The ``info`` dictionary can contain any number of key-value pairs that provide
metadata to identify the cell and the conditions it was tested under.

Converting data to PyProBE Format
---------------------------------
Expand Down

0 comments on commit cc1313f

Please sign in to comment.