docs(cli): fix command help typos, examples, and minor logging bugs#366
Open
divyansh-v15-06 wants to merge 1 commit into
Open
docs(cli): fix command help typos, examples, and minor logging bugs#366divyansh-v15-06 wants to merge 1 commit into
divyansh-v15-06 wants to merge 1 commit into
Conversation
- Fixed spelling errors in 'microcks start' help text and examples
- Added an Example usage block to the 'microcks stop' command
- Fixed a misspelled error string in localconfig.go ('undifined' -> 'undefined')
- Replaced a silent, ignored fmt.Errorf in watcher/executor.go with a proper fmt.Printf error log
Signed-off-by: rika <divyanshanshu90@gmail.com>
divyansh-v15-06
requested review from
Harsh4902,
lbroudoux and
yada
as code owners
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What does this PR do?
This PR focuses on improving the Developer Experience (DX) of the CLI by cleaning up user-facing documentation strings and fixing minor linting/logging bugs.
Specifically, this PR:
startCommand Typos: Corrects several spelling errors in the--helpexamples and flag descriptions ofcmd/start.go(e.g.,wnat->want,dokcer->docker, and missing 'r's inyour).stopCommand DX: Adds a missingExample:block tocmd/stop.goso that the usage output is consistent with the rest of the CLI.fmt.Errorfcall inpkg/watcher/executor.gowith a properfmt.Printf("[ERROR] ...")log so failures during config loading aren't swallowed silently."undifined") returned by theGetAuthfunction.Why is this important?
Accurate
--helpcommands are essential for good developer UX. Fixing these typos makes the CLI feel more polished and professional. Additionally, fixing the swallowed error in thewatcherensures that edge-case failures are properly communicated to the user.