Skip to content

Commit

Permalink
MINOR: [Python][Docs] Fix default for use_compliant_nested_type in pa…
Browse files Browse the repository at this point in the history
…rquet write_table docstring (apache#38471)

### Rationale for this change

the default value of use_compliant_nested_type is True

### What changes are included in this PR?

Change the comment from False to True

### Are these changes tested?
No, it just changed the comment

### Are there any user-facing changes?
No

Authored-by: Jiaxing Liang <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
  • Loading branch information
sfc-gh-jliang authored Oct 26, 2023
1 parent f2995b0 commit c46fd24
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion python/pyarrow/parquet/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -838,7 +838,7 @@ def _sanitize_table(table, new_schema, flavor):
use_compliant_nested_type : bool, default True
Whether to write compliant Parquet nested type (lists) as defined
`here <https://github.com/apache/parquet-format/blob/master/
LogicalTypes.md#nested-types>`_, defaults to ``False``.
LogicalTypes.md#nested-types>`_, defaults to ``True``.
For ``use_compliant_nested_type=True``, this will write into a list
with 3-level structure where the middle level, named ``list``,
is a repeated group with a single field named ``element``::
Expand Down

0 comments on commit c46fd24

Please sign in to comment.