Update documentation

Author: DenverCoder1

Diff for: README.md

@@ -159,6 +159,40 @@ print(output)
 """
 ```
 
+### 🪄 Merge adjacent cells
+
+```py
+from table2ascii import table2ascii, Merge, PresetStyle
+
+output = table2ascii(
+    header=["#", "G", "Merge", Merge.LEFT, "S"],
+    body=[
+        [1, 5, 6, 200, Merge.LEFT],
+        [2, "E", "Long cell", Merge.LEFT, Merge.LEFT],
+        ["Bonus", Merge.LEFT, Merge.LEFT, "F", "G"],
+    ],
+    footer=["SUM", "100", "200", Merge.LEFT, "300"],
+    style=PresetStyle.double_thin_box,
+    first_col_heading=True,
+)
+
+print(output)
+
+"""
+╔═════╦═════╤═══════╤═════╗
+║  #  ║  G  │ Merge │  S  ║
+╠═════╬═════╪═══╤═══╧═════╣
+║  1  ║  5  │ 6 │   200   ║
+╟─────╫─────┼───┴─────────╢
+║  2  ║  E  │  Long cell  ║
+╟─────╨─────┴───┬───┬─────╢
+║     Bonus     │ F │  G  ║
+╠═════╦═════╤═══╧═══╪═════╣
+║ SUM ║ 100 │  200  │ 300 ║
+╚═════╩═════╧═══════╧═════╝
+"""
+```
+
 ## ⚙️ Options
 
 All parameters are optional.

Diff for: docs/source/api.rst

@@ -3,24 +3,31 @@
 API Reference
 =============
 
+.. _table2ascii:
+
 table2ascii
 ~~~~~~~~~~~
 
 .. autofunction:: table2ascii
 
+.. _Alignment:
 
 Alignment
 ~~~~~~~~~
 
 .. autoenum:: Alignment
     :members:
 
+.. _Merge:
+
 Merge
 ~~~~~
 
 .. autoenum:: Merge
     :members:
 
+.. _PresetStyle:
+
 PresetStyle
 ~~~~~~~~~~~
 

Diff for: docs/source/usage.rst

@@ -59,8 +59,8 @@ Set column widths and alignments
        header=["#", "G", "H", "R", "S"],
        body=[["1", "30", "40", "35", "30"], ["2", "30", "40", "35", "30"]],
        first_col_heading=True,
-       column_widths=[5] * 5,  # [5, 5, 5, 5, 5]
-       alignments=[Alignment.LEFT] + [Alignment.RIGHT] * 4, # First is left, remaining 4 are right
+       column_widths=[5, 5, 5, 5, 5],
+       alignments=[Alignment.LEFT] + [Alignment.RIGHT] * 4,
    )
 
    print(output)
@@ -84,7 +84,7 @@ Use a preset style
    output = table2ascii(
        header=["First", "Second", "Third", "Fourth"],
        body=[["10", "30", "40", "35"], ["20", "10", "20", "5"]],
-       column_widths=[10] * 4,
+       column_widths=[10, 10, 10, 10],
        style=PresetStyle.ascii_box
    )
 
@@ -130,7 +130,7 @@ Check :ref:`TableStyle` for more info.
    output = table2ascii(
        header=["First", "Second", "Third"],
        body=[["10", "30", "40"], ["20", "10", "20"], ["30", "20", "30"]],
-       style=my_style
+       style=my_style,
    )
 
    print(output)
@@ -143,4 +143,41 @@ Check :ref:`TableStyle` for more info.
    |  20   :   10   :  20   |
    |  30   :   20   :  30   |
    *-------'--------'-------*
-   """
+   """
+
+Merge adjacent cells
+~~~~~~~~~~~~~~~~~~~~
+
+Check :ref:`Merge` for more info.
+
+.. code:: py
+
+    from table2ascii import table2ascii, Merge, PresetStyle
+
+    output = table2ascii(
+        header=["#", "G", "Merge", Merge.LEFT, "S"],
+        body=[
+            [1, 5, 6, 200, Merge.LEFT],
+            [2, "E", "Long cell", Merge.LEFT, Merge.LEFT],
+            ["Bonus", Merge.LEFT, Merge.LEFT, "F", "G"],
+        ],
+        footer=["SUM", "100", "200", Merge.LEFT, "300"],
+        style=PresetStyle.double_thin_box,
+        first_col_heading=True,
+    )
+
+    print(output)
+
+    """
+    ╔═════╦═════╤═══════╤═════╗
+    ║  #  ║  G  │ Merge │  S  ║
+    ╠═════╬═════╪═══╤═══╧═════╣
+    ║  1  ║  5  │ 6 │   200   ║
+    ╟─────╫─────┼───┴─────────╢
+    ║  2  ║  E  │  Long cell  ║
+    ╟─────╨─────┴───┬───┬─────╢
+    ║     Bonus     │ F │  G  ║
+    ╠═════╦═════╤═══╧═══╪═════╣
+    ║ SUM ║ 100 │  200  │ 300 ║
+    ╚═════╩═════╧═══════╧═════╝
+    """

Diff for: table2ascii/merge.py

@@ -8,28 +8,30 @@ class Merge(Enum):
     with the cell to its left.
 
     In the case that the contents of the merged cell are longer than the
-    contents of the unmerged cells in the rows above and below, the merged
-    cell will be wrapped onto multiple lines.
+    combined widths of the unmerged cells in the rows above and below,
+    the merged cell will be wrapped onto multiple lines. The ``column_widths``
+    option can be used to control the widths of the unmerged cells.
 
     Example::
 
         from table2ascii import table2ascii, Merge, PresetStyle
 
         table2ascii(
-            body=[
-                ["A", "B", "C", "D"],
-                ["E", "Long cell contents", Merge.LEFT, Merge.LEFT],
-            ],
+            header=["Name", "Price", "Category", "Stock"],
+            body=[["Milk", "$2.99", "N/A", Merge.LEFT]],
+            footer=["Description", "Milk is a nutritious beverage", Merge.LEFT, Merge.LEFT],
             style=PresetStyle.double_box,
         )
 
         \"\"\"
-        ╔═══╦═══╦═══╦═══╗
-        ║ A ║ B ║ C ║ D ║
-        ╠═══╬═══╩═══╩═══╣
-        ║ E ║ Long cell ║
-        ║   ║ contents  ║
-        ╚═══╩═══════════╝
+        ╔═════════════╦═══════╦══════════╦═══════╗
+        ║    Name     ║ Price ║ Category ║ Stock ║
+        ╠═════════════╬═══════╬══════════╩═══════╣
+        ║    Milk     ║ $2.99 ║       N/A        ║
+        ╠═════════════╬═══════╩══════════════════╣
+        ║ Description ║   Milk is a nutritious   ║
+        ║             ║         beverage         ║
+        ╚═════════════╩══════════════════════════╝
         \"\"\"
 
     .. versionadded:: 1.0.0

Diff for: table2ascii/table_style.py

@@ -5,7 +5,7 @@
 class TableStyle:
     """Class for storing information about a table style
 
-    Parts of the table labeled alphabetically:
+    Parts of the table labeled alphabetically from A to V:
 
     .. code-block::
 
@@ -58,9 +58,10 @@ class TableStyle:
 
     .. versionchanged:: 1.0.0
 
-        Added fields for ``col_row_top_tee``, ``col_row_bottom_tee``, ``heading_row_top_tee``,
-        ``heading_row_bottom_tee``, ``heading_col_body_row_top_tee``, ``heading_col_body_row_bottom_tee``,
-        ``heading_col_heading_row_top_tee``, ``heading_col_heading_row_bottom_tee``
+        Added fields for edges of merged cells -- ``col_row_top_tee``, ``col_row_bottom_tee``,
+        ``heading_row_top_tee``, ``heading_row_bottom_tee``, ``heading_col_body_row_top_tee``,
+        ``heading_col_body_row_bottom_tee``, ``heading_col_heading_row_top_tee``,
+        ``heading_col_heading_row_bottom_tee``
     """
 
     # parts of the table

Diff for: tests/test_merge.py

@@ -95,7 +95,7 @@ def test_merge_line_wrap():
         ],
         footer=[
             "Description",
-            "Long cell value that is merge and wraps to multiple lines",
+            "Long cell value that is merged and wraps to multiple lines",
             Merge.LEFT,
             Merge.LEFT,
             Merge.LEFT,
@@ -109,7 +109,7 @@ def test_merge_line_wrap():
         "╠═════════════╪═══════╪══════════╪═══════╪══════╣\n"
         "║ test        │ 443   │ test     │ 67    │ test ║\n"
         "╠═════════════╪═══════╧══════════╧═══════╧══════╣\n"
-        "║ Description │ Long cell value that is merge   ║\n"
+        "║ Description │ Long cell value that is merged  ║\n"
         "║             │ and wraps to multiple lines     ║\n"
         "╚═════════════╧═════════════════════════════════╝"
     )