[ARROW-15428] [Python] Address docstrings in Parquet classes and functions

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 8.0.0
• Component/s: Python
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/30910
• Assignee: Alenka Frim
• Reporter: Alessandro Molina
• Created: 24/Jan/22 15:31
• Updated: 11/Jan/23 11:37
• Resolved: 13/Apr/22 10:24

Description

Ensure all docstrings of all classes and functions referenced in https://arrow.apache.org/docs/python/api/formats.html#parquet-files have an Examples section

Most important:

/docs/python/generated/pyarrow.parquet.read_table.html
/docs/python/generated/pyarrow.parquet.write_table.html
/docs/python/generated/pyarrow.parquet.ParquetDataset.html
/docs/python/generated/pyarrow.parquet.ParquetFile.html
/docs/python/generated/pyarrow.parquet.ParquetWriter.html
/docs/python/generated/pyarrow.parquet.write_to_dataset.html

Issue Links

• links to: GitHub Pull Request #12704