dwigradcheck: explain how to obtain corrected gradient table #2321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdtournier
reviewed
May 17, 2021
bin/dwigradcheck
Outdated
| cmdline.set_author('Robert E. Smith (robert.smith@florey.edu.au)') | ||
| cmdline.set_synopsis('Check the orientation of the diffusion gradient table') | ||
| cmdline.add_description('Note that if the -mask command-line option is not specified, the MRtrix3 command dwi2mask will automatically be called to ' | ||
| cmdline.add_description('Note that the corrected gradient table can be output using the -export_grad_{mrtrix,fsl} option. \n\n' |
Member
There was a problem hiding this comment.
I think if you need to have several paragraphs in the description, the right way to do it is to provide each paragraph within its own cmdline.add_description() call - not explicitly hard-code the break as two newlines.
Member
Author
There was a problem hiding this comment.
Sorry... Thanks for fixing!
jdtournier
force-pushed
the
dwigradcheck-doc
branch
from
49166ff to
1073b07
Compare
jdtournier
force-pushed
the
dwigradcheck-doc
branch
from
1073b07 to
49166ff
Compare
Some users pointed out to me that it was not obvious how to obtain the corrected gradient table with dwigradcheck.
jdtournier
force-pushed
the
dwigradcheck-doc
branch
from
49166ff to
d80545f
Compare
jdtournier
approved these changes
Jul 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some users pointed out to me that it was not obvious how to obtain the corrected gradient table with dwigradcheck.