Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
korbinian90 committed Oct 3, 2024
1 parent ead755b commit c220dbc
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion ext/RomeoApp/argparse.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,9 @@ function getargs(args::AbstractVector, version)
"--correct-global", "-g"
help = """Phase is corrected to remove global n2π phase offset. The
median of phase values (inside mask if given) is used to
calculate the correction term"""
calculate the correction term. This also corrects multi-echo
phase for individual unwrapping, and might require MCPC3Ds
phase offset correction."""
action = :store_true
"--write-quality", "-q"
help = """Writes out the ROMEO quality map as a 3D image with one
Expand Down

2 comments on commit c220dbc

@korbinian90
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/116547

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.2.0 -m "<description of version>" c220dbc41190f2a7c18560c5def009b9c4f5eebd
git push origin v1.2.0

Please sign in to comment.