Skip to content

Commit

Permalink
ARROW-7628: [Python] Clarify docs of csv reader skip_rows and nulls i…
Browse files Browse the repository at this point in the history
…n strings

Closes #6463 from jorisvandenbossche/ARROW-7628-csv-doc and squashes the following commits:

19e6d30 <Joris Van den Bossche> update phrasing
fdfbeb9 <Joris Van den Bossche> ARROW-7628:  Clarify docs of csv reader skip_rows and nulls in strings

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: François Saint-Jacques <fsaintjacques@gmail.com>
  • Loading branch information
jorisvandenbossche authored and fsaintjacques committed Feb 21, 2020
1 parent 3c2f65f commit acfcc5b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions python/pyarrow/_csv.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ cdef class ReadOptions:
This will determine multi-threading granularity as well as
the size of individual chunks in the Table.
skip_rows: int, optional (default 0)
The number of rows to skip at the start of the CSV data, not
including the row of column names (if any).
The number of rows to skip before the column names (if any)
and the CSV data.
column_names: list, optional
The column names of the target table. If empty, fall back on
`autogenerate_column_names`.
Expand Down Expand Up @@ -109,8 +109,8 @@ cdef class ReadOptions:
@property
def skip_rows(self):
"""
The number of rows to skip at the start of the CSV data, not
including the row of column names (if any).
The number of rows to skip before the column names (if any)
and the CSV data.
"""
return self.options.skip_rows

Expand Down Expand Up @@ -296,7 +296,9 @@ cdef class ConvertOptions:
(disabling type inference on those columns).
null_values: list, optional
A sequence of strings that denote nulls in the data
(defaults are appropriate in most cases).
(defaults are appropriate in most cases). Note that by default,
string columns are not checked for null values. To enable
null checking for those, specify ``strings_can_be_null=True``.
true_values: list, optional
A sequence of strings that denote true booleans in the data
(defaults are appropriate in most cases).
Expand Down

0 comments on commit acfcc5b

Please sign in to comment.