Skip to content

Commit b5f3875

Browse files
dougbrnhombit
andauthored
Apply suggestions from code review
Co-authored-by: Konstantin Malanchev <[email protected]>
1 parent 03ec890 commit b5f3875

File tree

1 file changed

+7
-6
lines changed
  • src/nested_pandas/nestedframe

1 file changed

+7
-6
lines changed

src/nested_pandas/nestedframe/io.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ def read_parquet(
2929
Can be a local file path, HTTP/HTTPS URL, or S3 path.
3030
columns : list, default=None
3131
If not None, only these columns will be read from the file.
32-
reject_nesting: list or str, default=None
33-
Column(s) to reject from being cast to a nested dtype. By default,
34-
nested-pandas assumes that any struct column is castable to a nested
35-
column, but this is not always the case for a given struct. Any columns
36-
specified here will be read as their original struct type.
32+
reject_nesting: list or str, default=None
33+
Column(s) to reject from being cast to a nested dtype. By default,
34+
nested-pandas assumes that any struct column with all fields being lists
35+
is castable to a nested column. However, this assumption is invalid if
36+
the lists within the struct have mismatched lengths for any given item.
37+
Columns specified here will be read using the corresponding pandas.ArrowDtype.
3738
3839
Returns
3940
-------
@@ -45,7 +46,7 @@ def read_parquet(
4546
example ```pd.read_parquet("data.parquet", columns=["nested.a"])``` will
4647
load the "a" column of the "nested" column. Standard pandas/pyarrow
4748
behavior will return "a" as a list-array base column with name "a". In
48-
Nested-Pandas, this behavior is changed to load the column as a sub-column
49+
nested-pandas, this behavior is changed to load the column as a sub-column
4950
of a nested column called "nested". Be aware that this will prohibit calls
5051
like ```pd.read_parquet("data.parquet", columns=["nested.a", "nested"])```
5152
from working, as this implies both full and partial load of "nested".

0 commit comments

Comments
 (0)