diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2021-08-19 14:45:28 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2021-08-19 15:50:24 -0400 |
| commit | 8ba05ef8bcdd53bdd54999cc9885ab310b766d9c (patch) | |
| tree | 4a683b34d41710f94e7f259580ceb0ff1f46cc4b /docs/features | |
| parent | df1925db8607b06079ba78d497701ca961b855ab (diff) | |
| download | cmd2-git-8ba05ef8bcdd53bdd54999cc9885ab310b766d9c.tar.gz | |
set command output now uses SimpleTable.
Tabled tab completion now includes divider row.
Tab completion results for aliases, macros, and Settables wrap long fields.
SimpleTable now accepts blank for the divider character. It is identical to passing None.
Removed --verbose flag from set command so the descriptions always show.
Diffstat (limited to 'docs/features')
| -rw-r--r-- | docs/features/builtin_commands.rst | 26 | ||||
| -rw-r--r-- | docs/features/settings.rst | 8 |
2 files changed, 20 insertions, 14 deletions
diff --git a/docs/features/builtin_commands.rst b/docs/features/builtin_commands.rst index 14f340c2..97b160b5 100644 --- a/docs/features/builtin_commands.rst +++ b/docs/features/builtin_commands.rst @@ -102,16 +102,22 @@ within a running application: .. code-block:: text - (Cmd) set --verbose - allow_style: 'Terminal' # Allow ANSI text style sequences in output (valid values: Terminal, Always, Never) - always_show_hint: False # Display tab completion hint even when completion suggestions print - debug: True # Show full traceback on exception - echo: False # Echo command issued into output - editor: 'vi' # Program used by 'edit' - feedback_to_output: False # Include nonessentials in '|', '>' results - max_completion_items: 50 # Maximum number of CompletionItems to display during tab completion - quiet: False # Don't print nonessential feedback - timing: False # Report execution times + (Cmd) set + Name Value Description + ================================================================================================================== + allow_style Terminal Allow ANSI text style sequences in output (valid values: + Terminal, Always, Never) + always_show_hint False Display tab completion hint even when completion suggestions + print + debug True Show full traceback on exception + echo False Echo command issued into output + editor vi Program used by 'edit' + feedback_to_output False Include nonessentials in '|', '>' results + max_completion_items 50 Maximum number of CompletionItems to display during tab + completion + quiet False Don't print nonessential feedback + timing False Report execution times + Any of these user-settable parameters can be set while running your app with the ``set`` command like so: diff --git a/docs/features/settings.rst b/docs/features/settings.rst index c21b3258..0be46292 100644 --- a/docs/features/settings.rst +++ b/docs/features/settings.rst @@ -134,10 +134,10 @@ changes a setting, and will receive both the old value and the new value. .. code-block:: text - (Cmd) set --verbose | grep sunny - sunny: False # Is it sunny outside? - (Cmd) set --verbose | grep degrees - degrees_c: 22 # Temperature in Celsius + (Cmd) set | grep sunny + sunny False Is it sunny outside? + (Cmd) set | grep degrees + degrees_c 22 Temperature in Celsius (Cmd) sunbathe Too dim. (Cmd) set degrees_c 41 |