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

Consistent help text indentation using heredoc-style formatting #2722

Merged
merged 2 commits into from
Aug 22, 2023

Conversation

michaeldwan
Copy link
Contributor

Change Summary

What and Why:

A lot of our multi-line help text has wonky indentation because of how strings are formatted in the source code. This PR formats them with a heredoc helper to correct indentation automatically.

Before

$ go run . volume extend --help
Extends a target volume to the size specified. The instance is automatically restarted for Nomad (V1) apps.
		Most Machines (V2 apps) don't require a restart. Older Machines get a message to manually restart the Machine
		to increase the size of the FS.

After

$ go run . volume extend --help
Extends a target volume to the size specified. The instance is automatically restarted for Nomad (V1) apps.
Most Machines (V2 apps) don't require a restart. Older Machines get a message to manually restart the Machine
to increase the size of the FS.

How:

Related to:


Documentation

  • Fresh Produce
  • In superfly/docs, or asked for help from docs team
  • n/a

Copy link
Contributor

@billyb2 billyb2 left a comment

Choose a reason for hiding this comment

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

nice

@michaeldwan michaeldwan merged commit 8f905eb into master Aug 22, 2023
20 checks passed
@michaeldwan michaeldwan deleted the help-text-formatting branch August 22, 2023 17:06
@michaeldwan michaeldwan mentioned this pull request Aug 30, 2023
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.

2 participants