Skip to content

Commit 4c95cbd

Browse files
committed
Merge pull request #137 from adamrp/issue-126
Improve docstring on load_raw_data_cmd
2 parents 2dc78a3 + 018c198 commit 4c95cbd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Diff for: qiita_db/commands.py

+9
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,18 @@ def load_raw_data_cmd(filepaths, filepath_types, filetype, study_ids):
9191
Parameters
9292
----------
9393
filepaths : iterable of str
94+
Paths to the raw data files
9495
filepath_types : iterable of str
96+
Describes the contents of the files.
9597
filetype : str
98+
The type of file being loaded
9699
study_ids : iterable of int
100+
The IDs of the studies with which to associate this raw data
101+
102+
Returns
103+
-------
104+
qiita_db.RawData
105+
The newly created `qiita_db.RawData` object
97106
"""
98107
if len(filepaths) != len(filepath_types):
99108
raise ValueError("Please pass exactly one filepath_type for each "

0 commit comments

Comments
 (0)