Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Miscellaneous docstring fixes #2672

Merged
merged 3 commits into from Oct 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions dipy/workflows/denoise.py
Expand Up @@ -316,7 +316,7 @@ def get_short_name(cls):
@deprecated_params('num_threads', 'num_processes', since='1.4',
until='1.5')
def run(self, input_files, slice_axis=2, n_points=3, num_processes=1,
out_dir='', out_unring='dwi_unrig.nii.gz'):
out_dir='', out_unring='dwi_unring.nii.gz'):
r"""Workflow for applying Gibbs Ringing method.

Parameters
Expand All @@ -337,7 +337,7 @@ def run(self, input_files, slice_axis=2, n_points=3, num_processes=1,
use as many cores as possible). 0 raises an error.
out_dir : string, optional
Output directory. (default current directory)
out_unrig : string, optional
out_unring : string, optional
jhlegarreta marked this conversation as resolved.
Show resolved Hide resolved
Name of the resulting denoised volume.

References
Expand Down
10 changes: 6 additions & 4 deletions dipy/workflows/multi_io.py
Expand Up @@ -36,12 +36,12 @@ def connect_output_paths(inputs, out_dir, out_files,
The output directory.
out_files : array
List of output files.
output_strategy : string
output_strategy : string, optional
Which strategy to use to generate the output paths.
'append': Add out_dir to the path of the input.
'prepend': Add the input path directory tree to out_dir.
'absolute': Put directly in out_dir.
mix_names : bool
mix_names : bool, optional
Whether or not prepend a string composed of a mix of the input
names to the final output name.

Expand Down Expand Up @@ -130,10 +130,12 @@ def io_iterator(inputs, out_dir, fnames, output_strategy='absolute',
Output directory.
fnames : array
File names of all outputs to be created.
output_strategy : string
output_strategy : string, optional
Controls the behavior of the IOIterator for output paths.
mix_names : bool
mix_names : bool, optional
Whether or not to append a mix of input names at the beginning.
out_keys : list, optional
Output parameter names.
jhlegarreta marked this conversation as resolved.
Show resolved Hide resolved

Returns
-------
Expand Down