Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
DOC: Miscellaneous documentation fixes
Browse files Browse the repository at this point in the history
Miscellaneous documentation fixes:
- Fix paramater names in docstrings.
- Add missing parameters to docstrings.
- Remove non-existing arguments from docstrings.
- Fix grammar and typos.
  • Loading branch information
jhlegarreta committed Mar 15, 2024
1 parent bfb8fcc commit 9f4f38d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/eddymotion/data/pet.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class PET:
frame_time = attr.ib(default=None, repr=_data_repr)
"""A 1D numpy array with the midpoint timing of each sample."""
total_duration = attr.ib(default=None, repr=_data_repr)
"""A float number represaenting the total duration of acquisition."""
"""A float number representing the total duration of acquisition."""

em_affines = attr.ib(default=None)
"""
Expand Down
6 changes: 5 additions & 1 deletion src/eddymotion/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,15 @@ def fit(
Number of iterations this particular model is going to be repeated.
align_kwargs : :obj:`dict`
Parameters to configure the image registration process.
model : :obj:`str`
models : :obj:`list`
Selects the diffusion model that will generate the registration target
corresponding to each gradient map.
See :obj:`~eddymotion.model.ModelFactory` for allowed models (and corresponding
keywords).
omp_nthreads : :obj:`int`
Maximum number of threads an individual process may use.
n_jobs : :obj:`int`
Number of parallel jobs.
seed : :obj:`int` or :obj:`bool`
Seed the random number generator (necessary when we want deterministic
estimation).
Expand Down
2 changes: 0 additions & 2 deletions src/eddymotion/model/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ def init(model="DTI", **kwargs):
Parameters
----------
gtab : :obj:`numpy.ndarray`
An array representing the gradient table in RAS+B format.
model : :obj:`str`
Diffusion model.
Options: ``"DTI"``, ``"DKI"``, ``"S0"``, ``"AverageDW"``
Expand Down
6 changes: 3 additions & 3 deletions src/eddymotion/viz.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def draw_circles(positions, radius, n_samples=20):
r"""
Draw circular patches (lying on a sphere) at given positions.
Adapted from from `Emmanuel Caruyer's code
Adapted from `Emmanuel Caruyer's code
<https://github.com/ecaruyer/qspace/blob/master/qspace/visu/visu_points.py>`__,
which is distributed under the revised BSD License:
Expand Down Expand Up @@ -164,7 +164,7 @@ def draw_points(gradients, ax, rad_min=0.3, rad_max=0.7, cmap="viridis"):
"""
Draw the vectors on a shell.
Adapted from from `Emmanuel Caruyer's code
Adapted from `Emmanuel Caruyer's code
<https://github.com/ecaruyer/qspace/blob/master/qspace/visu/visu_points.py>`__,
which is distributed under the revised BSD License:
Expand All @@ -184,7 +184,7 @@ def draw_points(gradients, ax, rad_min=0.3, rad_max=0.7, cmap="viridis"):
gradients : array-like shape (N, 4)
A 2D numpy array of the gradient table in RAS+B format.
ax : :obj:`matplotlib.axes.Axis`
The matplolib axes instance to plot in.
The matplotlib axes instance to plot in.
rad_min : :obj:`float` between 0 and 1
Minimum radius of the circle that renders a gradient direction
rad_max : :obj:`float` between 0 and 1
Expand Down

0 comments on commit 9f4f38d

Please sign in to comment.