Skip to content

Commit e0ea1e0

Browse files
committed
Documentation: adds corrections to table info in Page.rst.
1 parent a1e8f1b commit e0ea1e0

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/page.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2373,6 +2373,8 @@ The `TableFinder` class is returned by :meth:`Page.find_tables` and has related
23732373

23742374
A reference to the :ref:`Page` object.
23752375

2376+
:type: :ref:`Page`
2377+
23762378

23772379
.. class:: Table
23782380

@@ -2381,9 +2383,9 @@ The `TableFinder` class is returned by :meth:`Page.find_tables` and has related
23812383

23822384
.. attribute:: page
23832385

2384-
A description of the page instance for the table.
2386+
A back-reference to the owning page.
23852387

2386-
:type: `string`
2388+
:type: :ref:`Page`
23872389

23882390
.. attribute:: cells
23892391

@@ -2394,14 +2396,14 @@ The `TableFinder` class is returned by :meth:`Page.find_tables` and has related
23942396

23952397
.. attribute:: header
23962398

2397-
A `TableHeader` object if detected.
2399+
A `TableHeader` object.
23982400

23992401
:type: `TableHeader`
24002402

24012403

24022404
.. attribute:: bbox
24032405

2404-
The bounding box of the table given as a tuple `(x0, y0, x1, y1)`. This is the rectangle that contains all cells of the table.
2406+
The bounding box of all cells of the table header.
24052407

24062408

24072409
:type: :ref:`Rect`
@@ -2431,7 +2433,7 @@ The `TableFinder` class is returned by :meth:`Page.find_tables` and has related
24312433

24322434
.. method:: extract()
24332435

2434-
Extracts table data into a list.
2436+
Extracts table cell text data into a list.
24352437

24362438
:type: list
24372439

@@ -2462,7 +2464,7 @@ The `TableFinder` class is returned by :meth:`Page.find_tables` and has related
24622464

24632465
.. attribute:: bbox
24642466

2465-
The bounding box of the table given as a tuple `(x0, y0, x1, y1)`. This is the rectangle that contains all cells of the table.
2467+
The bounding box of the union of cells belonging to the table header, given as a tuple (x0, y0, x1, y1). This rectangle contains all table header cells.
24662468

24672469
:type:`Rect`
24682470

0 commit comments

Comments
 (0)