diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-22 00:32:55 -0400 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-22 00:32:55 -0400 |
commit | e1256ccb5a78d8cb3b4f2ab9904d80693b6959c9 (patch) | |
tree | 8af8f150e8c84bfd671e22b6bd988e96d6fc1f1c /cmd2/table_creator.py | |
parent | a6f04d8f8d999a1440a34307d3646a33b2b23d74 (diff) | |
download | cmd2-git-e1256ccb5a78d8cb3b4f2ab9904d80693b6959c9.tar.gz |
Updated docs
Diffstat (limited to 'cmd2/table_creator.py')
-rw-r--r-- | cmd2/table_creator.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/cmd2/table_creator.py b/cmd2/table_creator.py index 28d16db7..b17bf452 100644 --- a/cmd2/table_creator.py +++ b/cmd2/table_creator.py @@ -21,12 +21,14 @@ SPACE = ' ' class HorizontalAlignment(Enum): + """Horizontal alignment of text in a cell""" LEFT = 1 CENTER = 2 RIGHT = 3 class VerticalAlignment(Enum): + """Vertical alignment of text in a cell""" TOP = 1 MIDDLE = 2 BOTTOM = 3 @@ -54,7 +56,7 @@ class Column: :param max_data_lines: maximum lines allowed in a data cell. If line count exceeds this, then the final line displayed will be truncated with an ellipsis. (defaults to INFINITY) :raises: ValueError if width is less than 1 - ValueError if max_data_lines is less than 1 + :raises: ValueError if max_data_lines is less than 1 """ self.header = header @@ -369,8 +371,8 @@ class TableCreator: and a right row border. (Defaults to blank) :return: row string :raises: ValueError if data isn't the same length as self.cols - TypeError if fill_char is more than one character (not including ANSI style sequences) - ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable + :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) + :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable character like a newline """ class Cell: |