Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ewels committed Jul 20, 2022
1 parent 8f83196 commit b56ef68
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/config/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ An overview of all available config options in all scopes is below:
| `--terminal-theme` | `TERMINAL_THEME` | `terminal_theme` |
| `--snippet-theme` | `SNIPPET_THEME` | `snippet_theme` |
| `--use-pty` | `USE_PTY` | `use_pty` |
| `--created-files` | `CREATED_FILES` | `-` |
| `--deleted-files` | `DELETED_FILES` | `-` |
| `--verbose` | `LOG_VERBOSE` | `log_verbose` \* |
| `--save-log` | `LOG_SAVE` | - |
| `--log-file` | `LOG_FILENAME` | - |
Expand Down Expand Up @@ -96,6 +98,8 @@ A brief description of each option follows.
- `--terminal-theme`: Colour theme
- `--snippet-theme`: Snippet Pygments theme
- `--use-pty`: Use a pseudo-terminal for commands (may capture coloured output)
- `--created-files`: Save a list of created files to this file
- `--deleted-files`: Save a list of deleted files to this file
- `--verbose`: Print verbose output to the console.
- `--save-log`: Save a verbose log to a file (automatic filename).
- `--log-file`: Save a verbose log to a file (specific filename).
Expand Down
2 changes: 1 addition & 1 deletion src/rich_codex/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@
"--deleted-files",
envvar="DELETED_FILES",
show_envvar=True,
help="SSave a list of deleted files to this file",
help="Save a list of deleted files to this file",
metavar="<filename>",
)
@click.option(
Expand Down

0 comments on commit b56ef68

Please sign in to comment.