Skip to content

Commit

Permalink
Fix docstring indentation in SaveImage (#7913)
Browse files Browse the repository at this point in the history
### Description

The docstring for `monai.transforms.io.array.SaveImage` had some faulty
indentation, causing weirdly formatted documentation on the website.
This pull request fixes the indentation.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [x] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Mathijs de Boer <m.deboer-41@umcutrecht.nl>
Co-authored-by: Mathijs de Boer <m.deboer-41@umcutrecht.nl>
  • Loading branch information
MathijsdeBoer and Mathijs de Boer authored Jul 11, 2024
1 parent 8cfbcba commit 9554f47
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions monai/transforms/io/array.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,11 +307,11 @@ class SaveImage(Transform):
Args:
output_dir: output image directory.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
output_postfix: a string appended to all output file names, default to `trans`.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
output_ext: output file extension name.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
Handled by ``folder_layout`` instead, if ``folder_layout`` is not ``None``.
output_dtype: data type (if not None) for saving data. Defaults to ``np.float32``.
resample: whether to resample image (if needed) before saving the data array,
based on the ``"spatial_shape"`` (and ``"original_affine"``) from metadata.
Expand Down

0 comments on commit 9554f47

Please sign in to comment.