Skip to content

Commit 7a5e466

Browse files
kdeldyckegithub-actions[bot]
authored andcommitted
Format Markdown
1 parent 00ebf94 commit 7a5e466

5 files changed

Lines changed: 24 additions & 25 deletions

File tree

docs/colorize.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,6 @@ assert result.output == dedent("""\
285285

286286
```{admonition} Why plain, linear output?
287287
:class: tip
288-
289288
A screen reader is not the only consumer that prefers a linear, minimal-width stream over a terminal-wide 2D layout. Command output is also pasted into bug reports, piped into other tools, and read on narrow screens. A layout that imposes a maximal width (full-width tables, box-drawing borders, whitespace-padded columns) wraps awkwardly or [grows a horizontal scrollbar](https://github.com/callowayproject/bump-my-version/pull/23#issuecomment-1602007874) once it leaves the terminal it was sized for, while a stream rendered at the minimal width of its text travels everywhere intact.
290289
291290
This is the same reasoning that keeps Click Extra from routing its help screens through [`rich-click`](https://github.com/ewels/rich-click), a good project integrating [Rich](https://github.com/Textualize/rich) with Click whose [help is laid out in a table](https://github.com/ewels/rich-click) spanning the whole terminal width. `--accessible` carries that preference from help screens to colors and tables. The two are not mutually exclusive, though: nothing stops you from using `rich-click` and Click Extra together and taking the best of both.

docs/context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The table below lists every entry Click Extra writes, the option that triggers i
4747
| `context.TABLE_FORMAT` | `click_extra.table_format` | `--table-format` callback (`@table_format_option`) | `TableFormat` |
4848
| `context.SORT_BY` | `click_extra.sort_by` | `--sort-by` callback (`@sort_by_option`) | `tuple[str, ...]` — column IDs in priority order |
4949
| `context.THEME` | `click_extra.theme.active` | `--theme` callback (always present on `@command`) | `HelpExtraTheme` — palette picked for this invocation |
50-
| `context.ZERO_EXIT` | `click_extra.zero_exit` | `-0` / `--zero-exit` callback (`@zero_exit_option`) | `bool``True` to always exit 0 *(write-only)* |
50+
| `context.ZERO_EXIT` | `click_extra.zero_exit` | `-0` / `--zero-exit` callback (`@zero_exit_option`) | `bool``True` to always exit 0 *(write-only)* |
5151

5252
## Worked examples
5353

docs/man-page.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,10 @@ The `FILES` section documents the files a program reads. Click Extra's `--config
158158

159159
The `EXIT STATUS` section documents the process return codes. Click Extra inherits Click's conventional scheme:
160160

161-
| Code | Meaning |
162-
| ---- | ----------------------------------------------------------------------------------------- |
163-
| `0` | Success. |
164-
| `1` | A runtime error, or an aborted prompt (`Ctrl-C`, a declined confirmation). |
161+
| Code | Meaning |
162+
| ---- | ------------------------------------------------------------------------------------------------ |
163+
| `0` | Success. |
164+
| `1` | A runtime error, or an aborted prompt (`Ctrl-C`, a declined confirmation). |
165165
| `2` | A usage error: unknown option, invalid value, missing operand, or an unparsable `--config` file. |
166166

167167
A successful run returns `0`:

docs/theme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Now invocations of the `weather` CLI pick up the light theme without passing `--
4444
| [`dracula`](#dracula) | 24-bit RGB | High-contrast dark theme with vivid neon accents. |
4545
| [`nord`](#nord) | 24-bit RGB | Cool-toned dark theme built around frost-blue and aurora accents. |
4646
| [`monokai`](#monokai) | 24-bit RGB | Classic dark theme with high-saturation magenta and lime accents. |
47-
| [`manpage`](#manpage) | None (monochrome) | Bold literals, italic replaceable, no color. Shadows a man page. |
47+
| [`manpage`](#manpage) | None (monochrome) | Bold literals, italic replaceable, no color. Shadows a man page. |
4848

4949
Each row is keyed by the `--theme` choice value; access the instance via `BUILTIN_THEMES["<name>"]` (e.g. `BUILTIN_THEMES["dark"]`). Click any name to jump to that theme's [palette listing](#palettes) below.
5050

docs/tutorial.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -217,25 +217,25 @@ Notice in the example above how the `@command()` decorator from Cloup is used wi
217217

218218
Click Extra provides these additional, pre-configured options decorators you can use standalone. Some of them are included by default in the {py:func}`@extra_command and @extra_group <click_extra.commands.default_extra_params>` decorators (see the last column):
219219

220-
| Decorator | Specification | Default |
221-
| ------------------------------------------------------------------ | ----------------------------------------- | ------- |
222-
| [`@timer_option`](execution.md#timer) | `--time / --no-time` ||
223-
| [`@accessible_option`](colorize.md#accessible-flag) | `--accessible` ||
224-
| [`@color_option`](colorize.md#color-no-color-flag) | `--color, --ansi / --no-color, --no-ansi` ||
225-
| [`@theme_option`](theme.md) | `--theme` ||
226-
| [`@config_option`](config.md#standalone-option) | `--config CONFIG_PATH` ||
227-
| [`@no_config_option`](config.md#) | `--no-config` ||
220+
| Decorator | Specification | Default |
221+
| --------------------------------------------------------------------- | ----------------------------------------- | ------- |
222+
| [`@timer_option`](execution.md#timer) | `--time / --no-time` ||
223+
| [`@accessible_option`](colorize.md#accessible-flag) | `--accessible` ||
224+
| [`@color_option`](colorize.md#color-no-color-flag) | `--color, --ansi / --no-color, --no-ansi` ||
225+
| [`@theme_option`](theme.md) | `--theme` ||
226+
| [`@config_option`](config.md#standalone-option) | `--config CONFIG_PATH` ||
227+
| [`@no_config_option`](config.md#) | `--no-config` ||
228228
| [`@validate_config_option`](config.md#validating-configuration-files) | `--validate-config FILE` ||
229-
| [`@show_params_option`](parameters.md#show-params-option) | `--show-params` ||
230-
| [`@table_format_option`](table.md) | `--table-format FORMAT` ||
231-
| [`@verbosity_option`](logging.md#colored-verbosity) | `--verbosity LEVEL` ||
232-
| {py:class}`@verbose_option <click_extra.logging.VerboseOption>` | `-v, --verbose` ||
233-
| [`@man_option`](man-page.md#generating-man-pages) | `--man` ||
234-
| [`@version_option`](version.md) | `--version` ||
235-
| {py:class}`@help_option <click_extra.colorize.HelpExtraFormatter>` | `-h, --help` ||
236-
| [`@jobs_option`](execution.md#parallel-jobs) | `--jobs INTEGER` ||
237-
| {py:mod}`@telemetry_option <click_extra.telemetry>` | `--telemetry / --no-telemetry` ||
238-
| [`@zero_exit_option`](execution.md#zero-exit-code) | `-0, --zero-exit` ||
229+
| [`@show_params_option`](parameters.md#show-params-option) | `--show-params` ||
230+
| [`@table_format_option`](table.md) | `--table-format FORMAT` ||
231+
| [`@verbosity_option`](logging.md#colored-verbosity) | `--verbosity LEVEL` ||
232+
| {py:class}`@verbose_option <click_extra.logging.VerboseOption>` | `-v, --verbose` ||
233+
| [`@man_option`](man-page.md#generating-man-pages) | `--man` ||
234+
| [`@version_option`](version.md) | `--version` ||
235+
| {py:class}`@help_option <click_extra.colorize.HelpExtraFormatter>` | `-h, --help` ||
236+
| [`@jobs_option`](execution.md#parallel-jobs) | `--jobs INTEGER` ||
237+
| {py:mod}`@telemetry_option <click_extra.telemetry>` | `--telemetry / --no-telemetry` ||
238+
| [`@zero_exit_option`](execution.md#zero-exit-code) | `-0, --zero-exit` ||
239239

240240
```{note}
241241
Because single-letter options are a scarce resource, Click Extra does not impose them on you. All the options above are specified with their long names only. You can always customize them to add a short name if you wish.

0 commit comments

Comments
 (0)