From 18a2993957502e247afb589adc248b6253931c4b Mon Sep 17 00:00:00 2001 From: Belyaeva Oksana Date: Fri, 22 Sep 2023 18:59:57 +0300 Subject: [PATCH] ESL-137 update docs --- dedoc/data_structures/cell_with_meta.py | 9 +++++++++ docs/source/modules/data_structures.rst | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/dedoc/data_structures/cell_with_meta.py b/dedoc/data_structures/cell_with_meta.py index 863c4d56..f0978a66 100644 --- 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 index 39628cff..b79c0002 100644 --- 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 --------------