Skip to content

Fix help page for algorithm module #2293

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

Jump to bottom
Merged
jdtournier merged 3 commits into from
Mar 3, 2021
Merged

Fix help page for algorithm module #2293

jdtournier merged 3 commits into from
Mar 3, 2021

Conversation

@Lestropie
Copy link
Member

@Lestropie Lestropie commented Mar 3, 2021

Closes #2292.

Before:

SYNOPSIS

     Perform B1 field inhomogeneity correction for a DWI volume series

USAGE

     dwibiascorrect [ options ] algorithm ...

        algorithm    Select the algorithm to be used to complete the script operation;
                     additional details and options become available once an
                     algorithm is nominated. Options are: ants, fsl

After:

SYNOPSIS

     Perform B1 field inhomogeneity correction for a DWI volume series

USAGE

     dwibiascorrect algorithm [ options ] ...

        algorithm    Select the algorithm to be used to complete the script operation;
                     additional details and options become available once an
                     algorithm is nominated. Options are: ants, fsl

@Lestropie
Fix help page for algorithm module
6e8a523 
For help page interfaces of algorithmm module wrapper scripts, do not insert the prospect of command-line options in between the wrapper name and the algorithm selection, as such usage will not work.
As reported in #2292.
@Lestropie Lestropie requested a review from a team March 3, 2021 01:52
@Lestropie Lestropie self-assigned this Mar 3, 2021
@Lestropie Lestropie mentioned this pull request Mar 3, 2021
Closed
@jdtournier jdtournier merged commit 248396e into master Mar 3, 2021
@jdtournier jdtournier deleted the algorithm_helppage_fix branch March 3, 2021 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jdtournier jdtournier jdtournier approved these changes

Assignees

@Lestropie Lestropie

Labels

bug documentation scripts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

dwibiascorrect: usage info misleading

3 participants

@Lestropie @jdtournier