apache / apache/arrow

[Python][Parquet] Reorganize Parquet reader docstrings

Open
#51,265 1 comment 0 reactions 0 assignees View on GitHub
Component: Parquet Component: Python good-first-issue Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

### Describe the enhancement requested

In the Python Parquet reader docstrings, many snippets are duplicated for describing various common options, such as `thrift_string_size_limit`.

We should deduplicate these snippets and find a way to reuse them across all Parquet reader docstrings. This will ease maintenance and reduce the risk of errors when updating those docstrings.

### Component(s)

Parquet, Python

Contributor guide

Open the contributing guide

Research direction

Locate the Python Parquet reader docstrings and compare the repeated option snippets, starting with the thrift_string_size_limit text named in the issue. Identify a reusable way to share those snippets across the reader docstrings; done means duplicated wording is removed while the documented options remain complete and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.