[FIX] Docstring cleaning: wrong underline length...

[skoudoro]

Related to #2523.

The goal of this PR is to fix the following warning during doc generation:

- UserWarning: potentially wrong underline length...

it also closes #2422

[pep8speaks]

Hello @skoudoro, Thank you for updating !

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated at 2022-02-24 22:23:04 UTC

[codecov]

Codecov Report

Merging #2533 (83b1217) into master (79e9605) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2533   +/-   ##
=======================================
  Coverage   84.89%   84.89%           
=======================================
  Files         126      126           
  Lines       17185    17185           
  Branches     2930     2930           
=======================================
  Hits        14590    14590           
  Misses       1922     1922           
  Partials      673      673           

Impacted Files	Coverage Δ
dipy/align/_public.py	82.60% <ø> (ø)
dipy/align/imaffine.py	95.95% <ø> (ø)
dipy/align/imwarp.py	98.42% <ø> (ø)
dipy/align/reslice.py	92.30% <ø> (ø)
dipy/align/scalespace.py	92.64% <ø> (ø)
dipy/align/streamlinear.py	85.35% <ø> (ø)
dipy/boots/resampling.py	20.77% <ø> (ø)
dipy/conftest.py	87.50% <ø> (ø)
dipy/core/geometry.py	91.19% <ø> (ø)
dipy/core/gradients.py	92.22% <ø> (ø)
... and 47 more

[skoudoro]

FAILED segment/tests/test_mrf.py::test_icm_square - AssertionError

Failing tests are not related. We need to relax/check test_icm_squarewhich seems to fail from time to time.