Revisit documentation recommendations for alignment #990
Labels
documentation
issues related to improving documentation for the project
effort: low
Theoretically less than a day's work
impact: low
Improving code/documentation cleanliness/clarity, not function
priority: low
issues that are not urgent
Summary
The documentation currently recommends running tedana before doing distortion correction or non-linear spatial alignments to a template and then has a note saying the other option is ok, but deserves more testing. Both options are ok and I'm not sure if either is better so we should present both in a more neutral manner that described the benefits and problems with each
Additional Detail
Relevant documentation section:
tedana/docs/multi-echo.rst
Lines 461 to 479 in b11d254
I think all the relevant points are there, but I'd reorganize to explain the benefits and problems with each approach rather than recommending one and making a note about the other option. (Full disclosure: It looks the way it currently does because of my previous recommendations and others probably wouldn't have recommended both in earlier versions of the documentation)
Tangential issue
An entire section of multi-echo.rst is not rendering on readthedocs:
tedana/docs/multi-echo.rst
Lines 443 to 458 in b11d254
I think there's a missing blank line that's causing the problem. This is fixed in the rendered docs for #970 (yay strict linting!), but figured I'd note this.
Next Steps
The text was updated successfully, but these errors were encountered: