Skip to content

better handling of long parameter names in the default formatter #72

@stevenklassen8376

Description

@stevenklassen8376

We have a case where we have some really long parameter names, which in the default formatting wraps all the descriptions into a single column. We work around this by specifying 120 columns, but a better solution would be if the formatter recognized that the names were over some threshold and then placed the description on the next line. So instead of the following:

required arguments:
  --messaging-internal-format-uri MESSAGING_INTERNAL_FORMAT_URI                     Uri to publish messages in the
                                                                                    internal format. e.g.
                                                                                    rabbit://user:pass@localhost:5672
                                                                                    ?exchange=some-name

  --messaging-internal-format-with-raw-uri MESSAGING_INTERNAL_FORMAT_WITH_RAW_URI   Uri to publish messages in the
                                                                                    internal format plus the raw
                                                                                    message. e.g.
                                                                                    rabbit://user:pass@localhost:5672
                                                                                    ?exchange=some-other-name

It could look like the following:

required arguments:
  --messaging-internal-format-uri MESSAGING_INTERNAL_FORMAT_URI                     
        Uri to publish messages in the internal format. e.g.
        rabbit://user:pass@localhost:5672?exchange=some-name

  --messaging-internal-format-with-raw-uri MESSAGING_INTERNAL_FORMAT_WITH_RAW_URI   
        Uri to publish messages in the internal format plus the raw message. e.g.
        rabbit://user:pass@localhost:5672?exchange=some-other-name

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions