MCPcopy Create free account
hub / github.com/cli/cli / longDescription

Function longDescription

pkg/cmd/accessibility/accessibility.go:68–143  ·  view source on GitHub ↗
(io *iostreams.IOStreams)

Source from the content-addressed store, hash-verified

66}
67
68func longDescription(io *iostreams.IOStreams) string {
69 cs := io.ColorScheme()
70 title := cs.Bold("Learn about GitHub CLI's accessibility experiences")
71 color := cs.Bold("Customizable and contrasting colors")
72 prompter := cs.Bold("Non-interactive user input prompting")
73 spinner := cs.Bold("Text-based spinners")
74 feedback := cs.Bold("Join the conversation")
75
76 return heredoc.Docf(`
77 %[2]s
78
79 As the home for all developers, we want every developer to feel welcome in our
80 community and be empowered to contribute to the future of global software
81 development with everything GitHub has to offer including the GitHub CLI.
82
83 %[3]s
84
85 Text interfaces often use color for various purposes, but insufficient contrast
86 or customizability can leave some users unable to benefit.
87
88 For a more accessible experience, the GitHub CLI can use color palettes
89 based on terminal background appearance and limit colors to 4-bit ANSI color
90 palettes, which users can customize within terminal preferences.
91
92 With this new experience, the GitHub CLI provides multiple options to address
93 color usage:
94
95 1. The GitHub CLI will use 4-bit color palette for increased color contrast based
96 on dark and light backgrounds including rendering Markdown based on the
97 GitHub Primer design system.
98
99 To enable this experience, use one of the following methods:
100 - Run %[1]sgh config set accessible_colors enabled%[1]s
101 - Set %[1]sGH_ACCESSIBLE_COLORS=enabled%[1]s environment variable
102
103 2. The GitHub CLI will display issue and pull request labels' custom RGB colors
104 in terminals with true color support.
105
106 To enable this experience, use one of the following methods:
107 - Run %[1]sgh config set color_labels enabled%[1]s
108 - Set %[1]sGH_COLOR_LABELS=enabled%[1]s environment variable
109
110 %[4]s
111
112 Interactive text user interfaces manipulate the terminal cursor to redraw parts
113 of the screen, which can be difficult for speech synthesizers or braille displays
114 to accurately detect and read.
115
116 For a more accessible experience, the GitHub CLI can provide a similar experience using
117 non-interactive prompts for user input.
118
119 To enable this experience, use one of the following methods:
120 - Run %[1]sgh config set accessible_prompter enabled%[1]s
121 - Set %[1]sGH_ACCESSIBLE_PROMPTER=enabled%[1]s environment variable
122
123 %[5]s
124
125 Motion-based spinners communicate in-progress activity by manipulating the

Callers 1

NewCmdAccessibilityFunction · 0.85

Calls 2

ColorSchemeMethod · 0.80
BoldMethod · 0.80

Tested by

no test coverage detected