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

Completion: Capitalize short desc and remove extra space from long #1455

Merged
merged 1 commit into from
Dec 7, 2021

Conversation

fcjr
Copy link
Contributor

@fcjr fcjr commented Jul 12, 2021

The help short desc is capitalized so we should follow its lead for consistency.

Also fixes #1458.

@CLAassistant
Copy link

CLAassistant commented Jul 12, 2021

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@marckhouzam marckhouzam left a comment

Choose a reason for hiding this comment

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

Thanks @fcjr. You are right, the completion command should follow the pattern of the help command.

I assume there is no backwards-compatibility concerns about a command description or help text, but I'll leave that up to the maintainers.

@brianstrauch
Copy link

As per #1458, the Long description is also inconsistent. Can we add a fix for that to this PR?

@fcjr
Copy link
Contributor Author

fcjr commented Jul 19, 2021

As per #1458, the Long description is also inconsistent. Can we add a fix for that to this PR?

Updated to fix the extra newline in the long desc.

@fcjr fcjr changed the title Capitalize short desc for completion command Completion: Capitalize short desc, and remove extra space from long Jul 19, 2021
@fcjr fcjr changed the title Completion: Capitalize short desc, and remove extra space from long Completion: Capitalize short desc and remove extra space from long Jul 20, 2021
@fcjr
Copy link
Contributor Author

fcjr commented Aug 15, 2021

Just a friendly ping on this, is there any chance this can be merged and released?

@github-actions
Copy link

This PR is being marked as stale due to a long period of inactivity

@fcjr
Copy link
Contributor Author

fcjr commented Oct 25, 2021

Bumping b/c it was marked as stale =)

Copy link

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

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

This looks good to me.

Copy link

@invidian invidian left a comment

Choose a reason for hiding this comment

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

Cool! LGTM

@jpmcb jpmcb merged commit c3573e2 into spf13:master Dec 7, 2021
@jpmcb jpmcb removed the kind/stale label Dec 7, 2021
@jpmcb jpmcb added this to the 1.3.0 milestone Dec 7, 2021
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

Successfully merging this pull request may close these issues.

Default help and completion command descriptions are inconsistent
8 participants