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

Help text is only taken from the last line of doc comments #25

Closed
boustrophedon opened this issue Oct 15, 2017 · 2 comments
Closed

Help text is only taken from the last line of doc comments #25

boustrophedon opened this issue Oct 15, 2017 · 2 comments
Labels
bug This is a BUG. The fix may be released in a patch version even if considered breaking

Comments

@boustrophedon
Copy link

If you have something like

#[derive(StructOpt, Debug)]
struct Args {
    /// Doc comment: First line
    /// Doc comment: Second line
    parameter: String,
}

the help text for parameter will be "Doc comment: Second line". This is a problem when you have a long help text, but you want to keep a reasonable line length.
@TeXitoi TeXitoi added the bug This is a BUG. The fix may be released in a patch version even if considered breaking label Oct 25, 2017
@TeXitoi TeXitoi closed this as completed in 94ed62d Nov 1, 2017
TeXitoi added a commit that referenced this issue Nov 1, 2017
@TeXitoi
Handle multiline doc comment as help message
96a726a 
fix #25
@boustrophedon
Copy link
Author

Awesome thanks!

@TeXitoi
Copy link
Owner

TeXitoi commented Nov 3, 2017

Welcome.

@peterhuene peterhuene mentioned this issue Dec 20, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug This is a BUG. The fix may be released in a patch version even if considered breaking
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@boustrophedon @TeXitoi