Navigation Menu

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

Added template functions for multi-line Description formatting. #1175

Conversation

imle
Copy link
Contributor

@imle imle commented Aug 17, 2020

Added functions to template system for consistent multi-line Description formatting.

What type of PR is this?

  • bug
  • cleanup
  • documentation
  • feature

What this PR does / why we need it:

Formatting for multi-line descriptions indents the first line of the description but none of the consecutive lines. This adds functions to the templating that adjusts multi-line printing to automatically add the 3 spaces to every line while maintaining the user defined spacing.

Which issue(s) this PR fixes:

No current issue is open for this.

Testing

Included a test to verify the expected output.

Release Notes

The default help text now indents all lines in a App and Command's Description field.

@imle imle requested a review from a team as a code owner August 17, 2020 20:07
@imle imle requested review from rliebz and coilysiren and removed request for a team August 17, 2020 20:07
@imle
Copy link
Contributor Author

imle commented Sep 29, 2020

Any reason this cannot be merged?

@imle
Copy link
Contributor Author

imle commented Oct 27, 2020

@rliebz or @lynncyrin is there a reason this cannot be merged?

@coilysiren
Copy link
Member

I can give this a look later probably, but I have a heavy workload right now so it may slip

@rliebz
Copy link
Member

rliebz commented Oct 31, 2020

Sorry for the delay here, this is a huge improvement!

Copy link
Member

@asahasrabuddhe asahasrabuddhe left a comment

Choose a reason for hiding this comment

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

I agree, this is a wonderful addition. Thanks!

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.

None yet

4 participants