8000 Manual of `gh config` need backquotes around settings and default values · Issue #8478 · cli/cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Manual of gh config need backquotes around settings and default values #8478

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.

Sign up for GitHub

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

Jump to bottom
Closed
muzimuzhi opened this issue Dec 20, 2023 · 0 comments · Fixed by #8479
Closed

Manual of gh config need backquotes around settings and default values #8478

muzimuzhi opened this issue Dec 20, 2023 · 0 comments · Fixed by #8479
Labels
enhancement a request to improve CLI needs-triage needs to be reviewed

Comments

@muzimuzhi
Copy link
Contributor

Describe the feature or problem you’d like to solve

gh config documentation is generated differenctly, hence not covered in #8342.
https://cli.github.com/manual/gh_config

image

Proposed solution

Backquote settings and default values.

Additional context

cli/pkg/cmd/config/config.go

Lines 16 to 26 in 541ce0e

func NewCmdConfig(f *cmdutil.Factory) *cobra.Command {
longDoc := strings.Builder{}
longDoc.WriteString("Display or change configuration settings for gh.\n\n")
longDoc.WriteString("Current respected settings:\n")
for _, co := range config.ConfigOptions() {
longDoc.WriteString(fmt.Sprintf("- %s: %s", co.Key, co.Description))
if co.DefaultValue != "" {
longDoc.WriteString(fmt.Sprintf(" (default: %q)", co.DefaultValue))
}
longDoc.WriteRune('\n')
}

@muzimuzhi muzimuzhi added the enhancement a request to improve CLI label Dec 20, 2023
@cliAutomation cliAutomation added the needs-triage needs to be reviewed label Dec 20, 2023
@muzimuzhi muzimuzhi mentioned this issue Dec 20, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement a request to improve CLI needs-triage needs to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Backquote settings in gh-config docs
3 participants
@muzimuzhi @cliAutomation and others
0