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.

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

Multiple doc attributes are not supported, and multi-line doc comments retain their exact whitespace #42

Open
Nemo157 opened this issue Aug 12, 2020 · 0 comments

Comments

@Nemo157
Copy link

Nemo157 commented Aug 12, 2020

#[derive(Debug, gumdrop::Options)]
struct Args {
    /// Which base58 alphabet to decode/encode with [possible values: bitcoin, monero,
    /// ripple, flickr or custom(abc...xyz)]
    alphabet: Alphabet,

    help: bool
}

This will only display the first line of doc comment in --help.


#[derive(Debug, gumdrop::Options)]
struct Args {
     /** Which base58 alphabet to decode/encode with [possible values: bitcoin, monero,
      ripple, flickr or custom(abc...xyz)] */
    alphabet: Alphabet,

    help: bool
}

This retains the indentation from the multi-line doc comment resulting in misaligned text in --help

Optional arguments:
  -a, --alphabet ALPHABET  Which base58 alphabet to decode/encode with [possible values: bitcoin, monero,
     ripple, flickr or custom(abc...xyz)]
vi added a commit to vi/syn-file-expand that referenced this issue Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant