Skip to content
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

Clarify argparse help description #3840

Merged
merged 4 commits into from Jul 27, 2022
Merged

Clarify argparse help description #3840

merged 4 commits into from Jul 27, 2022

Conversation

joshuacwnewton
Copy link
Member

Checklist

GitHub

PR contents

Description

This PR copies the docstring description and moves it to the argparse help description of sct_merge_images.

Linked issues

Fixes #3829.

@joshuacwnewton joshuacwnewton added documentation category: readthedocs, sourceforge, or SCT courses sct_merge_images context: labels Jul 13, 2022
@joshuacwnewton joshuacwnewton added this to the 5.7 milestone Jul 13, 2022
@joshuacwnewton
sct_merge_images: Reword description to improve clarity
c8705ef 
I figure it's clearer to use names for the quantities being calculated, rather than repeatedly using 0.5.
mguaypaq
mguaypaq approved these changes Jul 27, 2022
View reviewed changes
Copy link
Member

@mguaypaq mguaypaq left a comment

Choose a reason for hiding this comment

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

Maybe I'm biased as a mathematician, but this explanation seems much clearer to me.

jcohenadad
jcohenadad approved these changes Jul 27, 2022
View reviewed changes
Copy link
Member

@jcohenadad jcohenadad left a comment

Choose a reason for hiding this comment

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

excellent! thank you so much!

@mguaypaq mguaypaq merged commit 39838fc into master Jul 27, 2022
@mguaypaq mguaypaq deleted the jn/3829-clarify_sct_merge_images_description branch July 27, 2022 20:27
@mguaypaq mguaypaq changed the title Clarify argparse help description for sct_merge_images Clarify argparse help description Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mguaypaq mguaypaq mguaypaq approved these changes

@jcohenadad jcohenadad jcohenadad approved these changes

Assignees
No one assigned
Labels
documentation category: readthedocs, sourceforge, or SCT courses sct_merge_images context:
Projects
None yet
Milestone
5.7
Development

Successfully merging this pull request may close these issues.

Clarify documentation for sct_merge_images
3 participants
@joshuacwnewton @mguaypaq @jcohenadad