Skip to content

DOC: Fix references to os.PathLike #242

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 17, 2025
Merged

DOC: Fix references to os.PathLike #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions nitransforms/io/x5.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,14 @@ def to_filename(fname: str | Path, x5_list: List[X5Transform]):

Parameters
----------
fname : :obj:`os.pathlike`
fname : :obj:`os.PathLike`
The file name (preferably with the ".x5" extension) in which transforms will be stored.
x5_list : :obj:`list`
The list of transforms to be stored in the output dataset.

Returns
-------
fname : :obj:`os.pathlike`
fname : :obj:`os.PathLike`
File containing the transform(s).

"""
Expand Down
6 changes: 3 additions & 3 deletions nitransforms/resampling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ async def _apply_serial(
----------
data : :obj:`~numpy.ndarray`
The input data array.
spatialimage : :obj:`~nibabel.spatialimages.SpatialImage` or `os.pathlike`
spatialimage : :obj:`~nibabel.spatialimages.SpatialImage` or :obj:`os.PathLike`
The image object containing the data to be resampled in reference
space
targets : :obj:`~numpy.ndarray`
Expand Down Expand Up @@ -162,10 +162,10 @@ def apply(
----------
transform: :obj:`~nitransforms.base.TransformBase`
The 3D, 3D+t, or 4D transform through which data will be resampled.
spatialimage : :obj:`~nibabel.spatialimages.SpatialImage` or `os.pathlike`
spatialimage : :obj:`~nibabel.spatialimages.SpatialImage` or :obj:`os.PathLike`
The image object containing the data to be resampled in reference
space
reference : :obj:`~nibabel.spatialimages.SpatialImage` or `os.pathlike`
reference : :obj:`~nibabel.spatialimages.SpatialImage` or :obj:`os.PathLike`
The image, surface, or combination thereof containing the coordinates
of samples that will be sampled.
order : :obj:`int`, optional
Expand Down
Loading