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

fix: improve completions help formatting #1444

Merged
merged 1 commit into from Dec 7, 2021
Merged

fix: improve completions help formatting #1444

merged 1 commit into from Dec 7, 2021

Conversation

caarlos0
Copy link
Contributor

@caarlos0 caarlos0 commented Jul 7, 2021

did some improvements on the completions docs so they look a bit better if exported as markdown (and still look good on plain text):

  • indent the example command lines so they are rendered as code blocks
  • removed the $ prefix so they are easier to copy/paste
  • standarized the Linux and macOS subsections when present

example:

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
@CLAassistant
Copy link

CLAassistant commented Jul 7, 2021

CLA assistant check
All committers have signed the CLA.

@caarlos0 caarlos0 changed the title feat: improve completions help formatting fix: improve completions help formatting Jul 7, 2021
Copy link
Collaborator

@marckhouzam marckhouzam left a comment

This is a nice improvement. Thanks @caarlos0!

@caarlos0
Copy link
Contributor Author

caarlos0 commented Jul 30, 2021

Hey, what's left to get this merged? Anything else I can help?

@github-actions
Copy link

github-actions bot commented Sep 29, 2021

This PR is being marked as stale due to a long period of inactivity

@caarlos0
Copy link
Contributor Author

caarlos0 commented Sep 29, 2021

can we merge this yet?

umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 5, 2021
Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 15, 2021
Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 16, 2021
Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
afiune
afiune approved these changes Nov 21, 2021
Copy link

@afiune afiune left a comment

I was about to improve this as well, I wonder how can we help get this merged.

tenor-43883856

@afiune
Copy link

afiune commented Nov 21, 2021

Hey @jpmcb 👋🏽 - Do you think you can do a quick review here, this is just improving some documentation. 🤞🏽

@umarcor
Copy link
Contributor

umarcor commented Nov 21, 2021

@afiune @caarlos0 this is listed in #1496 already, and merged in #1525. See #1527 for further info.

@afiune
Copy link

afiune commented Nov 21, 2021

This is awesome! Thank you @umarcor 🙌🏽

jpmcb
jpmcb approved these changes Dec 7, 2021
@jpmcb jpmcb merged commit dd40ab0 into spf13:master Dec 7, 2021
2 checks passed
@jpmcb jpmcb removed the kind/stale label Dec 7, 2021
@jpmcb jpmcb added this to the 1.3.0 milestone Dec 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants