ESL-137 update docs

ispras · Sep 22, 2023 · 18a2993 · 18a2993
1 parent 156586a
commit 18a2993
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/dedoc/data_structures/cell_with_meta.py b/dedoc/data_structures/cell_with_meta.py
@@ -8,7 +8,16 @@
 
 
 class CellWithMeta:
+    """
+        This class holds the information about the cell information: text of the cell, text annotations and cell properties (rowspan, colspan, invisible).
+    """
     def __init__(self, lines: List[LineWithMeta], colspan: int = 1, rowspan: int = 1, invisible: bool = False) -> None:
+        """
+               :param lines: text lines (LineWithMeta) of the cell
+               :param colspan: The value of the rowspan attribute represents the number of columns to span. Like HTML format.
+               :param rowspan: The value of the rowspan attribute represents the number of rows to span. Like HTML format.
+               :param invisible: Display or hide cell values
+               """
         self.lines = lines
         self.colspan = colspan
         self.rowspan = rowspan

diff --git a/docs/source/modules/data_structures.rst b/docs/source/modules/data_structures.rst
@@ -66,12 +66,13 @@ Main classes defining a document
     :exclude-members: to_dict
     :members:
 
-.. autoclass:: dedoc.data_structures.CellProperty
+.. autoclass:: dedoc.data_structures.CellWithMeta
     :show-inheritance:
     :special-members: __init__
     :exclude-members: to_dict
     :members:
 
+
 Helper classes
 --------------