Skip to content

Feature request: smarter parsing of doc comments #134

@Lucretiel

Description

@Lucretiel

If I have a docopt like this:

#[structopt(short="n", long="no-op")]
/// Run the command as normal, but don't modify the file
///
/// In no-op mode, rewrite will do everything it normally does, including
/// writing to a temporary file, if enabled. The only thing it doesn't do is
/// modify the contents of the file.
no_op: bool,

It would be nice if structopt detected the line break, and set the separate parts as help and long_help. It would also be nice if it automatically reflows the line breaks correctly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    breaking-changeThis change is breaking and, if implemented, must be postponed until the next minor releaseenhancementWe would love to have this feature! Feel free to supply a PR

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions