Improve Help for build.sh #860
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cimnine
added
the
maintenance
cimnine
force-pushed
the
HereDocForBuildHelp
branch
from
21ce06e to
d96e8f1
Compare
tobiasge
approved these changes
Oct 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue: N/A
New Behavior
The help text is now a HEREDOC, which makes it easier to maintain.
It also contains some highlighting and colors to make the help text easier to read.
Contrast to Current Behavior
It was hard to maintain the help with all the echo statement. It made it especially hard to maintain the correct indention.
Discussion: Benefits and Drawbacks
The only drawback I see is that certain build systems possibly don't handle the formatting (bold, cyan, green) well. But on a build system the help text should never be displayed, so I see that as a neglectable drawback.
Changes to the Wiki
n/a
Proposed Release Note Entry
Improved the formatting of the help text of the
build.sh, see./build.sh --help.Double Check
developbranch.