This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new c46fd24ede MINOR: [Python][Docs] Fix default for
use_compliant_nested_type in parquet write_table docstring (#38471)
c46fd24ede is described below
commit c46fd24ededd0a0cd758e1a0dfb3a3e4fd4fbad4
Author: Jiaxing Liang <[email protected]>
AuthorDate: Thu Oct 26 02:40:59 2023 -0700
MINOR: [Python][Docs] Fix default for use_compliant_nested_type in parquet
write_table docstring (#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]>
---
python/pyarrow/parquet/core.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/python/pyarrow/parquet/core.py b/python/pyarrow/parquet/core.py
index 51ad955d19..072ab7fa11 100644
--- a/python/pyarrow/parquet/core.py
+++ b/python/pyarrow/parquet/core.py
@@ -838,7 +838,7 @@ data_page_version : {"1.0", "2.0"}, default "1.0"
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``::