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

Adjustments to documentation #1656

Merged
merged 1 commit into from Sep 11, 2022
Merged

Conversation

marckhouzam
Copy link
Collaborator

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.

@github-actions github-actions bot added the size/M Denotes a PR that chanes 24-99 lines label Apr 7, 2022
@marckhouzam marckhouzam added kind/documentation Documentation of cobra itself size/M Denotes a PR that chanes 24-99 lines and removed size/M Denotes a PR that chanes 24-99 lines labels Apr 7, 2022
@marckhouzam marckhouzam changed the title Ajustements to documentation Adjustments to documentation Apr 7, 2022
user_guide.md Outdated
@@ -603,7 +605,7 @@ Did you mean this?
Run 'hugo --help' for usage.
```

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

@johnSchnake johnSchnake left a comment

Choose a reason for hiding this comment

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

1 nit but find to merge to me.

@johnSchnake
Copy link
Collaborator

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
jpmcb approved these changes Apr 8, 2022
Copy link
Collaborator

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

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

Nice! 👍🏼

@jpmcb jpmcb added the lgtm Denotes "looks good to me" from maintainers and signals other collaboratores that a PR is ready label Apr 8, 2022
@github-actions
Copy link

github-actions bot commented Jun 8, 2022

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed.
    You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

@github-actions github-actions bot added the lifecycle/stale Labeled by GitHub actions after 30 days of inactivity label Jun 8, 2022
@CLAassistant
Copy link

CLAassistant commented Jun 27, 2022

CLA assistant check
All committers have signed the CLA.

@marckhouzam
Copy link
Collaborator Author

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.

@github-actions github-actions bot removed the lifecycle/stale Labeled by GitHub actions after 30 days of inactivity label Jun 28, 2022
@github-actions
Copy link

github-actions bot commented Sep 8, 2022

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed.
    You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

@github-actions github-actions bot added the lifecycle/stale Labeled by GitHub actions after 30 days of inactivity label Sep 8, 2022
@jpmcb jpmcb added lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten and removed lifecycle/stale Labeled by GitHub actions after 30 days of inactivity lgtm Denotes "looks good to me" from maintainers and signals other collaboratores that a PR is ready labels Sep 8, 2022
@jpmcb
Copy link
Collaborator

jpmcb commented Sep 11, 2022

@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
Copy link
Collaborator Author

@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 👀

Thanks, I had forgotten about that. I forced push and if fixed the CLA bot.

@marckhouzam marckhouzam merged commit 7e289f4 into spf13:main Sep 11, 2022
17 checks passed
@marckhouzam marckhouzam deleted the fix/doc branch September 11, 2022 21:48
@marckhouzam marckhouzam added this to the 1.6.0 milestone Sep 11, 2022
jimschubert added a commit to jimschubert/cobra that referenced this pull request Oct 3, 2022
* 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)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation of cobra itself lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten size/M Denotes a PR that chanes 24-99 lines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants