diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-22 20:14:59 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-22 20:14:59 -0700 |
| commit | 44bf30ae5634046c1e428d1e2438d0f1a4cdcd43 (patch) | |
| tree | 035ceb8b3c055023e92b3b87fec3cb51ab68e42d /docs/api/utils.rst | |
| parent | 94e6309c0339a8460f9e97b097328ec6a7baac31 (diff) | |
| download | cmd2-git-44bf30ae5634046c1e428d1e2438d0f1a4cdcd43.tar.gz | |
Instead of using automodule, only document public api functions
Diffstat (limited to 'docs/api/utils.rst')
| -rw-r--r-- | docs/api/utils.rst | 75 |
1 files changed, 74 insertions, 1 deletions
diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 8019b379..2ae5987b 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -1,5 +1,78 @@ cmd2.utils ========== -.. automodule:: cmd2.utils + +Settings +-------- + +.. autoclass:: cmd2.utils.Settable + :members: + + .. automethod:: __init__ + + +Quote Handling +-------------- + +.. autofunction:: cmd2.utils.is_quoted + +.. autofunction:: cmd2.utils.quote_string + +.. autofunction:: cmd2.utils.quote_string_if_needed + +.. autofunction:: cmd2.utils.strip_quotes + + +IO Handling +----------- + +.. autoclass:: cmd2.utils.StdSim + :members: + +.. autoclass:: cmd2.utils.ByteBuf :members: + +.. autoclass:: cmd2.utils.ProcReader + :members: + + +Tab Completion +-------------- + +.. autoclass:: cmd2.utils.CompletionError + :members: + +.. autofunction:: cmd2.utils.remove_duplicates + +.. autofunction:: cmd2.utils.alphabetical_sort + +.. autofunction:: cmd2.utils.natural_sort + +.. autofunction:: cmd2.utils.basic_complete + + +Text Alignment +-------------- + +.. autoclass:: cmd2.utils.TextAlignment + :members: + +.. autofunction:: cmd2.utils.align_text + +.. autofunction:: cmd2.utils.align_left + +.. autofunction:: cmd2.utils.align_right + +.. autofunction:: cmd2.utils.align_center + +.. autofunction:: cmd2.utils.truncate_line + + +Miscellaneous +------------- + +.. autofunction:: cmd2.utils.str_to_bool + +.. autofunction:: cmd2.utils.namedtuple_with_defaults + +.. autofunction:: cmd2.utils.categorize |