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

Wrap command description in help #1804

Merged
merged 4 commits into from
Oct 1, 2022

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Sep 25, 2022

Pull Request

Problem

The "full" command description is not being wrapped in the help.

See: #1785

Solution

Add wrapping of full description.

To work nicely with complex multiline descriptions, some subtle changes to the patterns:

  • don't block wrapping just because text contains consecutive empty lines (look for pre-indented lines)
  • preserve empty lines in description

Being conservative and marked as semver major because changing help may break client unit tests that depend on the exact output, although only a cosmetic change.

ChangeLog

  • add wrapping of command description in help

@shadowspawn shadowspawn added the semver: major Releasing requires a major version bump, not backwards compatible label Sep 25, 2022
@shadowspawn shadowspawn changed the base branch from develop to release/10.x September 26, 2022 01:17
@shadowspawn shadowspawn marked this pull request as ready for review September 26, 2022 01:17
Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

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

👍

@shadowspawn shadowspawn merged commit 186f0c8 into tj:release/10.x Oct 1, 2022
@shadowspawn shadowspawn deleted the feature/wrap-description branch October 1, 2022 23:12
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Oct 1, 2022
@shadowspawn shadowspawn added this to the v10.0.0 milestone Dec 8, 2022
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Jan 14, 2023
@shadowspawn
Copy link
Collaborator Author

Released in Commander v10.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver: major Releasing requires a major version bump, not backwards compatible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants