Conversation
marckhouzam
added
kind/documentation
user_guide.md
Outdated
| ``` | ||
|
|
||
| Suggestions are automatic based on every subcommand registered and use an implementation of [Levenshtein distance](http://en.wikipedia.org/wiki/Levenshtein_distance). Every registered command that matches a minimum distance of 2 (ignoring case) will be displayed as a suggestion. | ||
| Suggestions are automatic, based on existing subcommands and use an implementation of [Levenshtein distance](http://en.wikipedia.org/wiki/Levenshtein_distance). Every registered command that matches a minimum distance of 2 (ignoring case) will be displayed as a suggestion. |
There was a problem hiding this comment.
nit: I'm not an english major and not sure if a comma is appropriate here. It reads best to me if instead of a comma we use an 'and'
Suggestions are automatic and based on existing commands...
There was a problem hiding this comment.
Funny because I started out using an and, but then when reading the entire sentence, having two ands didn't sound right either: "Suggestions are automatic and based... and use..."
How about:
"Suggestions are automatically generated based on existing subcommands and use an implementation of Levenshtein distance."
I'll push an update using that formulation and you can let me know if it sounds better.
johnSchnake
left a comment
johnSchnake
left a comment
There was a problem hiding this comment.
1 nit but find to merge to me.
|
I'll wait 24hr to see if anyone else wants review or modify the nit. Otherwise I'll merge next time I see revisit. |
jpmcb
added
the
lgtm
|
The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:
|
|
|
|
Hmm... Editing online seems to have done a commit that doesn't pass the CLA check. I'll have to clean that up once I'm at a full computer. |
|
The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:
|
jpmcb
added
lifecycle/frozen
|
@marckhouzam - Does this need a squash / force push to make the CLA bot happy? I think this is good to go if you want to get this in a good state 👀 |
Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
marckhouzam
force-pushed
the
fix/doc
branch
from
7460fce to
b30b0aa
Compare
Thanks, I had forgotten about that. I forced push and if fixed the CLA bot. |
* main: (39 commits) Add '--version' flag to Help output (spf13#1707) Expose ValidateRequiredFlags and ValidateFlagGroups (spf13#1760) Document option to hide the default completion cmd (spf13#1779) ci: add workflow_dispatch (spf13#1387) add missing license headers (spf13#1809) ci: use action/setup-go's cache (spf13#1783) Adjustments to documentation (spf13#1656) Rename Powershell completion tests (spf13#1803) Support for case-insensitive command names (spf13#1802) Deprecate ExactValidArgs() and test combinations of args validators (spf13#1643) Use correct stale action `exempt-` yaml keys (spf13#1800) With go 1.18, we must use go install for a binary (spf13#1726) Clarify SetContext documentation (spf13#1748) ci: test on Golang 1.19 (spf13#1782) fix: show flags that shadow parent persistent flag in child help (spf13#1776) Update gopkg.in/yaml.v2 to gopkg.in/yaml.v3 (spf13#1766) fix(bash-v2): activeHelp length check syntax (spf13#1762) fix: correct command path in see_also for YAML doc (spf13#1771) build(deps): bump github.com/inconshreveable/mousetrap (spf13#1774) docs: add zitadel to the list (spf13#1772) ...
4 participants
I was going through the user-guide which I'm not sure I had read through and through before.
These are small ajustements I noticed were needed.