Add readme image for styling tables.

Also changelog for #69 and #70
ewels · May 17, 2022 · 5b5c98a · 5b5c98a
1 parent 50d89b7
commit 5b5c98a
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Version 1.3.3.dev0
 
+- Fixed `AttributeError` from `envvar` code in some Typer usage [[#70](https://github.com/ewels/rich-click/pull/70)]
+- Added support for styling the tables that options and commands are displayed in [[#69](https://github.com/ewels/rich-click/issues/69)]
+
 ## Version 1.3.2 (2022-05-16)
 
 - Fix missed indentation issue in subcommand help text with `inspect.cleandoc` [[#67](https://github.com/ewels/rich-click/pull/67)]

diff --git a/README.md b/README.md
@@ -262,6 +262,12 @@ click.rich_click.STYLE_OPTIONS_TABLE_LEADING = 1
 click.rich_click.STYLE_OPTIONS_TABLE_BOX = "SIMPLE"
 ```
 
+You can make some really ~horrible~ _colourful_ solutions using these styles if you wish:
+
+![Rich markup example](https://raw.githubusercontent.com/ewels/rich-click/main/docs/images/style_tables.png)
+
+> See [`examples/click/04_rich_markup.py`](examples/click/10_table_styles.py) for and example.
+
 See the [_Configuration options_](#configuration-options) section below for the full list of available options.
 
 ## Groups and sorting

diff --git a/docs/images/style_tables.png b/docs/images/style_tables.png
diff --git a/examples/click/10_table_styles.py b/examples/click/10_table_styles.py
@@ -5,7 +5,6 @@
 click.rich_click.STYLE_OPTIONS_TABLE_ROW_STYLES = ["bold", ""]
 click.rich_click.STYLE_COMMANDS_TABLE_SHOW_LINES = True
 click.rich_click.STYLE_COMMANDS_TABLE_PAD_EDGE = True
-click.rich_click.STYLE_COMMANDS_TABLE_PADDING = (1, 2)
 click.rich_click.STYLE_COMMANDS_TABLE_BOX = "DOUBLE"
 click.rich_click.STYLE_COMMANDS_TABLE_BORDER_STYLE = "red"
 click.rich_click.STYLE_COMMANDS_TABLE_ROW_STYLES = ["magenta", "yellow", "cyan", "green"]