add documentation

pull/126/head
Idan David 2020-04-05 13:49:44 +03:00
parent dbabc5b1c1
commit 2a8c24e672
2 changed files with 7 additions and 1 deletions

View File

@ -43,6 +43,9 @@ def read_pdf(
columns^ : list, optional (default: None)
List of column x-coordinates strings where the coordinates
are comma-separated.
rows^ : list, optional (default: None)
List of rows y-coordinates strings where the coordinates
are comma-separated.
split_text : bool, optional (default: False)
Split text that spans across multiple cells.
flag_size : bool, optional (default: False)

View File

@ -20,7 +20,7 @@ class Stream(BaseParser):
"""Stream method of parsing looks for spaces between text
to parse the table.
If you want to specify columns when specifying multiple table
If you want to specify rows or columns when specifying multiple table
areas, make sure that the length of both lists are equal.
Parameters
@ -52,6 +52,9 @@ class Stream(BaseParser):
column_tol : int, optional (default: 0)
Tolerance parameter used to combine text horizontally,
to generate columns.
rows : list, optional (default: None)
List of rows y-coordinates strings where the coordinates
are comma-separated
"""