Krisztian Szucs created ARROW-12718: ---------------------------------------
Summary: [Python][Doc] Exercise numpydoc in the CI checks Key: ARROW-12718 URL: https://issues.apache.org/jira/browse/ARROW-12718 Project: Apache Arrow Issue Type: Improvement Components: Documentation, Python Reporter: Krisztian Szucs Numpydoc helps identifying issues with our docstrings, for example we can list the undocumented parameters using the following command: ```bash archery numpydoc -a PR01 ``` parts of the output: ```console pyarrow.parquet.write_table PR01: Parameters {'use_compliant_nested_type', 'where', 'row_group_size', 'use_byte_stream_split', 'compression_level', '**kwargs'} not documented pyarrow.parquet.write_metadata PR01: Parameters {'where', 'metadata_collector'} not documented pyarrow.parquet.read_table PR01: Parameters {'source', 'columns'} not documented pyarrow.parquet.read_pandas PR01: Parameters {'source', '**kwargs', 'columns'} not documented pyarrow.parquet.PartitionSet PR01: Parameters {'keys', 'name'} not documented pyarrow.parquet.PartitionSet.get_index PR01: Parameters {'key'} not documented pyarrow.parquet.ParquetWriter PR01: Parameters {'writer_engine_version', 'use_compliant_nested_type', 'use_byte_stream_split', 'compression_level'} not documented ``` ```console pyarrow._flight.RecordBatchStream -> pyarrow._flight.RecordBatchStream(data_source, options=None) PR01: Parameters {'options', 'data_source'} not documented pyarrow._flight.Location -> pyarrow._flight.Location(uri) PR01: Parameters {'uri'} not documented pyarrow._flight.for_grpc_unix -> pyarrow._flight.Location.for_grpc_unix(path) PR01: Parameters {'path'} not documented pyarrow._flight.for_grpc_tls -> pyarrow._flight.Location.for_grpc_tls(host, port) PR01: Parameters {'host', 'port'} not documented pyarrow._flight.for_grpc_tcp -> pyarrow._flight.Location.for_grpc_tcp(host, port) PR01: Parameters {'host', 'port'} not documented pyarrow._flight.GeneratorStream -> pyarrow._flight.GeneratorStream(schema, generator, options=None) PR01: Parameters {'options', 'schema', 'generator'} not documented pyarrow._flight.FlightWriteSizeExceededError -> pyarrow._flight.A write operation exceeded the client-configured limit. PR01: Parameters {'actual', 'limit', 'message'} not documented ``` -- This message was sent by Atlassian Jira (v8.3.4#803005)