Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Aug 15, 2024
1 parent 90cc727 commit c6e0de3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion api/docs/v2/parameters/using_values.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The :py:obj:`.CSVParameter.file` parameter provides a `file handler object <http

The :py:obj:`.CSVParameter.contents` parameter returns the entire contents of the CSV file as a single string. You then need to parse the data yourself to extract the information you need.

The :py:meth:`.CSVParameter.parse_as_csv` method returns CSV data in a structured format. Specifically, it is a list of list of strings. This lets you access any "cell" of your tabular data by row and column index. This example parses a runtime parameter named ``csv_data``, stores the parsed data as ``parsed_csv``, and then accesses different portions of the data::
The :py:meth:`.CSVParameter.parse_as_csv` method returns CSV data in a structured format. Specifically, it is a list of lists of strings. This lets you access any "cell" of your tabular data by row and column index. This example parses a runtime parameter named ``csv_data``, stores the parsed data as ``parsed_csv``, and then accesses different portions of the data::

parsed_csv = protocol.params.csv_data
parsed_csv[0] # first row (header, if present)
Expand Down

0 comments on commit c6e0de3

Please sign in to comment.