Skip to content

Commit d0ed5c8

Browse files
completing docstring for parameters of get_next_sub (#482)
* completing docstring for parameters of get_next_sub * Test JZ commit. * Apply review feedback. --------- Co-authored-by: JoeZiminski <Joseph.j.ziminski@gmail.com>
1 parent ff1f29f commit d0ed5c8

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

datashuttle/datashuttle_class.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,16 +1075,18 @@ def get_next_sub(
10751075
include_central: bool = False,
10761076
) -> str:
10771077
"""
1078-
Convenience function for get_next_sub_or_ses
1078+
Convenience function for `get_next_sub_or_ses`
10791079
to find the next subject number.
10801080
10811081
Parameters
10821082
----------
1083+
top_level_folder
1084+
The top-level folder, "rawdata" or "derivatives".
10831085
1084-
return_with_prefix : bool
1085-
If `True`, return with the "sub-" prefix.
1086+
return_with_prefix
1087+
If `True`, return the subject with the "sub-" prefix.
10861088
1087-
include_central : bool
1089+
include_central
10881090
If `False, only get names from `local_path`, otherwise from
10891091
`local_path` and `central_path`. If in local-project mode,
10901092
this flag is ignored.
@@ -1122,16 +1124,16 @@ def get_next_ses(
11221124
Parameters
11231125
----------
11241126
1125-
top_level_folder:
1126-
"rawdata" or "derivatives"
1127+
top_level_folder
1128+
The top-level folder, "rawdata" or "derivatives".
11271129
1128-
sub: Optional[str]
1130+
sub
11291131
Name of the subject to find the next session of.
11301132
1131-
return_with_prefix : bool
1133+
return_with_prefix
11321134
If `True`, return with the "ses-" prefix.
11331135
1134-
include_central : bool
1136+
include_central
11351137
If `False, only get names from `local_path`, otherwise from
11361138
`local_path` and `central_path`. If in local-project mode,
11371139
this flag is ignored.

0 commit comments

Comments
 (0)