Skip to content

Commit 4700635

Browse files
authored
Update 'list_files' parameter documentation
Use the Python function parameter name ('source_directory') instead of the parameter name used by the IJ macro.
1 parent 24126c7 commit 4700635

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

src/imcflibs/imagej/bdv.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -921,14 +921,11 @@ def define_dataset_manual(
921921
definition_opts : dict
922922
Dictionary containing the details about the file repartitions.
923923
list_files : list of str, optional
924-
If provided, a list of file names to pass directly to the manual
925-
loader in "show_list" mode. When `list_files` is given the
926-
function will include the filenames in the options string instead
927-
of relying on a file pattern; items should be either basenames or
928-
paths appropriate for the selected ``image_file_directory``.
929-
924+
An optional list of file names to pass directly to the manual loader in
925+
"show_list" mode. When provided, the function will include the filenames
926+
in the options string instead of relying on a file pattern; items should
927+
be either full paths or relative to the selected `source_directory`.
930928
"""
931-
932929
# xml_filename = project_filename + ".xml"
933930

934931
if definition_opts is None:

0 commit comments

Comments
 (0)