Skip to content

Commit 1346254

Browse files
authored
refactor: improved swc loading doc
1 parent 009e85d commit 1346254

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

src/segmentation_skeleton_metrics/utils/swc_util.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,14 @@ def read(self, swc_pointer):
6767
----------
6868
swc_pointer : dict, list, str
6969
Object that points to SWC files to be read, must be one of:
70-
- swc_dir (str): Path to directory containing SWC files.
7170
- swc_path (str): Path to single SWC file.
72-
- swc_path_list (List[str]): List of paths to SWC files.
73-
- swc_zip (str): Path to a ZIP archive containing SWC files.
74-
- swc_zip_dir (str): Path to directory of ZIPs with SWC files.
71+
- swc_dir_path (str): Path to local directory containing SWC files.
72+
- swc_zip_path (str): Path to a local ZIP archive containing SWC files.
73+
- swc_zip_dir_path (str): Path to directory of ZIPs with SWC files.
74+
- swc_s3_dir_path (str): Path to S3 directory containing SWC files.
75+
- swc_gcs_dir_path (str): Path to GCS directory containing SWC files.
76+
- swc_gcs_zip_dir_path (str): Path to GCS directory containing ZIP archives of SWC files.
77+
- swc_path_list (List[str]): List of paths to SWC files on local machine.
7578
7679
Returns
7780
-------

0 commit comments

Comments
 (0)