@@ -76,8 +76,8 @@ The major things users should be aware of when upgrading to 3.x are detailed in
7676#### ansi
7777
7878The functionality within the ` cmd2.ansi ` module has either been removed or changed to be based on
79- ` rich ` and moved to one of the new modules: [ cmd2.string_utils ] [ ] , [ cmd2.styles ] [ ] , or
80- [ cmd2.terminal_utils ] [ ] .
79+ ` rich ` and moved to one of the new modules: [ cmd2.colors ] [ ] , [ cmd2.string_utils ] [ ] , or
80+ [ cmd2.styles ] [ ] .
8181
8282To ease the migration path from ` cmd2 ` 2.x to 3.x, we have created the ` cmd2-ansi ` module which is a
8383backport of the ` cmd2.ansi ` module present in ` cmd2 ` 2.7.0 in a standalone fashion. Relevant links:
@@ -163,11 +163,11 @@ example for a demonstration of how to use the common [cmd2.string_utils.stylize]
163163#### terminal_utils
164164
165165Support for terminal control escape sequences for things like setting the window title and
166- asynchronous alerts has been moved from ` cmd2.ansi ` to the new [ cmd2.terminal_utils ] [ ] module .
166+ asynchronous alerts has been moved from ` cmd2.ansi ` to within the main ` cmd2.Cmd ` application class .
167167
168168This isn't really intended to be used by end users, but is used by higher-level functionality that
169169is intended to be used by end users such as [ cmd2.Cmd.set_window_title] [ ] and
170- [ cmd2.Cmd.async_alert ] [ ] .
170+ [ cmd2.Cmd.add_alert ] [ ] .
171171
172172See [ async_printing.py] ( https://github.com/python-cmd2/cmd2/blob/main/examples/async_printing.py )
173173for an example of how to use this functionality in a ` cmd2 ` application.
@@ -177,11 +177,11 @@ for an example of how to use this functionality in a `cmd2` application.
177177` cmd2 ` now has 5 different Argparse HelpFormatter classes, all of which are based on the
178178` RichHelpFormatter ` class from [ rich-argparse] ( https://github.com/hamdanal/rich-argparse ) .
179179
180- - [ Cmd2HelpFormatter] [ cmd2.argparse_custom .Cmd2HelpFormatter ]
181- - [ ArgumentDefaultsCmd2HelpFormatter] [ cmd2.argparse_custom .ArgumentDefaultsCmd2HelpFormatter ]
182- - [ MetavarTypeCmd2HelpFormatter] [ cmd2.argparse_custom .MetavarTypeCmd2HelpFormatter ]
183- - [ RawDescriptionCmd2HelpFormatter] [ cmd2.argparse_custom .RawDescriptionCmd2HelpFormatter ]
184- - [ RawTextCmd2HelpFormatter] [ cmd2.argparse_custom .RawTextCmd2HelpFormatter ]
180+ - [ Cmd2HelpFormatter] [ cmd2.rich_utils .Cmd2HelpFormatter ]
181+ - [ ArgumentDefaultsCmd2HelpFormatter] [ cmd2.rich_utils .ArgumentDefaultsCmd2HelpFormatter ]
182+ - [ MetavarTypeCmd2HelpFormatter] [ cmd2.rich_utils .MetavarTypeCmd2HelpFormatter ]
183+ - [ RawDescriptionCmd2HelpFormatter] [ cmd2.rich_utils .RawDescriptionCmd2HelpFormatter ]
184+ - [ RawTextCmd2HelpFormatter] [ cmd2.rich_utils .RawTextCmd2HelpFormatter ]
185185
186186Previously the default ` Cmd2HelpFormatter ` class inherited from ` argparse.RawTextHelpFormatter ` ,
187187however it now inherits from ` argparse.HelpFormatter ` . If you want RawText behavior, then pass
0 commit comments