Refactor: move usage string to the constant #3480
Open
Conversation
This file contains 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
dmaluka
reviewed
Sep 26, 2024
| @@ -29,6 +29,49 @@ import ( | |||
| "github.com/zyedidia/tcell/v2" | |||
| ) | |||
|
|
|||
| const usage = `Usage: micro [OPTIONS] [FILE]... | |||
| -clean | |||
| Cleans the configuration directory | |||
There was a problem hiding this comment.
With hltaberrors enabled, the leading spaces here are highlighted as an error..
Why do we even print both spaces and a tab (" \t")? Can't we print just a tab, or just 8 spaces?
| Cleans the configuration directory | ||
| -config-dir dir | ||
| Specify a custom location for the configuration directory | ||
| [FILE]:LINE:COL (if the ` + "`parsecursor`" + ` option is enabled) |
There was a problem hiding this comment.
So this makes it not so unquestionable whether the code actually becomes more readable?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The PR moves usage string to a constant to improve readability and maintainability.
The micro's output remains the same
Before:
$ ./micro -h > before.txtAfter this PR:
./micro -h > after.txtDiff is empty: