[GitHub] [arrow] kszucs edited a comment on pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

[GitBox <gi...@apache.org>]

kszucs edited a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-871726097


   Truncated log with a single rule (PR01) to check enabled:
   
   ```
   ...
   
   pyarrow.lib.is_boolean_value
   -> pyarrow.lib.is_boolean_value(obj)
   PR01: Parameters {'obj'} not documented
   
   pyarrow.types.is_boolean
   PR01: Parameters {'t'} not documented
   
   pyarrow.types.is_binary
   PR01: Parameters {'t'} not documented
   
   pyarrow.gandiva.module.make_projector
   -> pyarrow.gandiva.make_projector(Schema schema, children, MemoryPool pool, unicode selection_mode=u'NONE')
   PR01: Parameters {'schema', 'selection_mode', 'pool', 'children'} not documented
   
   pyarrow.gandiva.module.make_filter
   -> pyarrow.gandiva.make_filter(Schema schema, Condition condition)
   PR01: Parameters {'schema', 'condition'} not documented
   
   pyarrow.lib.frombytes
   -> pyarrow.lib.frombytes(o, *, safe=False)
   PR01: Parameters {'safe', 'o'} not documented
   
   pyarrow.parquet.write_table
   PR01: Parameters {'use_compliant_nested_type', 'use_byte_stream_split', 'where', '**kwargs', 'row_group_size', 'compression_level'} not documented
   
   pyarrow.parquet.write_metadata
   PR01: Parameters {'where', 'metadata_collector'} not documented
   
   pyarrow.parquet.read_table
   PR01: Parameters {'columns', 'source'} not documented
   
   pyarrow.parquet.read_pandas
   PR01: Parameters {'**kwargs', 'source', '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
   
   pyarrow.parquet.ParquetFile
   PR01: Parameters {'read_dictionary'} not documented
   
   pyarrow.parquet.ParquetFile.read_row_groups
   PR01: Parameters {'row_groups', 'columns'} not documented
   
   pyarrow.parquet.ParquetFile.read_row_group
   PR01: Parameters {'i', 'columns'} not documented
   
   pyarrow.parquet.ParquetFile.read
   PR01: Parameters {'columns'} not documented
   
   pyarrow.parquet.ParquetFile.iter_batches
   PR01: Parameters {'batch_size', 'row_groups', 'columns'} not documented
   
   pyarrow.parquet.ParquetDatasetPiece
   PR01: Parameters {'file_options'} not documented
   
   pyarrow.parquet.ParquetDatasetPiece.read
   PR01: Parameters {'use_pandas_metadata'} not documented
   
   pyarrow.parquet.ParquetDataset
   PR01: Parameters {'metadata_nthreads'} not documented
   
   pyarrow.parquet.ParquetDataset.read_pandas
   PR01: Parameters {'**kwargs'} not documented
   
   pyarrow._csv.write_csv
   -> pyarrow._csv.write_csv(data, output_file, write_options=None, MemoryPool memory_pool=None)
   PR01: Parameters {'output_file', 'write_options', 'memory_pool', 'data'} not documented
   
   pyarrow._csv.read_csv
   -> pyarrow._csv.read_csv(input_file, read_options=None, parse_options=None, convert_options=None, MemoryPool memory_pool=None)
   PR01: Parameters {'memory_pool', 'read_options', 'convert_options', 'input_file', 'parse_options'} not documented
   
   pyarrow._csv.open_csv
   -> pyarrow._csv.open_csv(input_file, read_options=None, parse_options=None, convert_options=None, MemoryPool memory_pool=None)
   PR01: Parameters {'memory_pool', 'read_options', 'convert_options', 'input_file', 'parse_options'} not documented
   
   pyarrow._csv.ReadOptions
   -> pyarrow._csv.ReadOptions(use_threads=None, *, block_size=None, skip_rows=None, column_names=None, autogenerate_column_names=None, encoding=u'utf8', skip_rows_after_names=None)
   PR01: Parameters {'encoding', 'column_names', 'skip_rows', 'autogenerate_column_names', 'skip_rows_after_names'} not documented
   
   pyarrow._csv.ParseOptions
   -> pyarrow._csv.ParseOptions(delimiter=None, *, quote_char=None, double_quote=None, escape_char=None, newlines_in_values=None, ignore_empty_lines=None)
   PR01: Parameters {'double_quote', 'delimiter', 'newlines_in_values', 'quote_char', 'escape_char', 'ignore_empty_lines'} not documented
   
   pyarrow._csv.ConvertOptions
   -> pyarrow._csv.ConvertOptions(check_utf8=None, *, column_types=None, null_values=None, true_values=None, false_values=None, strings_can_be_null=None, quoted_strings_can_be_null=None, include_columns=None, include_missing_columns=None, auto_dict_encode=None, auto_dict_max_cardinality=None, timestamp_parsers=None)
   PR01: Parameters {'true_values', 'column_types', 'quoted_strings_can_be_null', 'strings_can_be_null', 'false_values', 'include_columns', 'auto_dict_max_cardinality', 'include_missing_columns', 'null_values', 'auto_dict_encode', 'timestamp_parsers'} not documented
   
   pyarrow._dataset.TaggedRecordBatch
   -> pyarrow._dataset.A combination of a record batch and the fragment it came from.
   PR01: Parameters {'record_batch', 'fragment'} not documented
   
   pyarrow._dataset.RowGroupInfo
   -> pyarrow._dataset.A wrapper class for RowGroup information
   PR01: Parameters {'schema', 'id', 'metadata'} not documented
   
   pyarrow._flight.connect
   -> pyarrow._flight.connect(location, **kwargs)
   PR01: Parameters {'**kwargs', 'location'} not documented
   
   pyarrow._flight.Ticket
   -> pyarrow._flight.Ticket(ticket)
   PR01: Parameters {'ticket'} not documented
   
   pyarrow._flight.SchemaResult
   -> pyarrow._flight.SchemaResult(Schema schema)
   PR01: Parameters {'schema'} not documented
   
   pyarrow._flight.Result
   -> pyarrow._flight.Result(buf)
   PR01: Parameters {'buf'} not documented
   
   pyarrow._flight.RecordBatchStream
   -> pyarrow._flight.RecordBatchStream(data_source, options=None)
   PR01: Parameters {'data_source', 'options'} 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 {'schema', 'generator', 'options'} not documented
   
   pyarrow._flight.FlightWriteSizeExceededError
   -> pyarrow._flight.A write operation exceeded the client-configured limit.
   PR01: Parameters {'message', 'actual', 'limit'} not documented
   
   pyarrow._flight.FlightServerBase
   -> pyarrow._flight.FlightServerBase(location=None, auth_handler=None, tls_certificates=None, verify_client=None, root_certificates=None, middleware=None)
   PR01: Parameters {'auth_handler', 'verify_client', 'root_certificates', 'middleware', 'tls_certificates'} not documented
   
   pyarrow._flight.FlightMethod
   -> pyarrow._flight.The implemented methods in Flight.
   PR01: Parameters {'qualname', 'type', 'names', 'start', 'value', 'module'} not documented
   
   pyarrow._flight.FlightInfo
   -> pyarrow._flight.FlightInfo(Schema schema, FlightDescriptor descriptor, endpoints, total_records, total_bytes)
   PR01: Parameters {'schema', 'endpoints', 'total_records', 'descriptor', 'total_bytes'} not documented
   
   pyarrow._flight.FlightError
   -> pyarrow._flight.FlightError(message=u'', extra_info=b'')
   PR01: Parameters {'message', 'extra_info'} not documented
   
   pyarrow._flight.FlightEndpoint
   -> pyarrow._flight.FlightEndpoint(ticket, locations)
   PR01: Parameters {'ticket', 'locations'} not documented
   
   pyarrow._flight.for_path
   -> pyarrow._flight.FlightDescriptor.for_path(*path)
   PR01: Parameters {'*path'} not documented
   
   pyarrow._flight.for_command
   -> pyarrow._flight.FlightDescriptor.for_command(command)
   PR01: Parameters {'command'} not documented
   
   pyarrow._flight.FlightClient
   -> pyarrow._flight.FlightClient(location, tls_root_certs=None, *, cert_chain=None, private_key=None, override_hostname=None, middleware=None, write_size_limit_bytes=None, disable_server_verification=None, generic_options=None)
   PR01: Parameters {'generic_options', 'override_hostname', 'cert_chain', 'tls_root_certs', 'middleware', 'disable_server_verification', 'private_key', 'write_size_limit_bytes'} not documented
   
   pyarrow._flight.FlightCallOptions
   -> pyarrow._flight.FlightCallOptions(timeout=None, write_options=None, headers=None)
   PR01: Parameters {'write_options', 'timeout', 'headers'} not documented
   
   pyarrow._flight.DescriptorType
   PR01: Parameters {'qualname', 'type', 'names', 'start', 'value', 'module'} not documented
   
   pyarrow._flight.CertKeyPair
   -> pyarrow._flight.A TLS certificate and key for use in Flight.
   PR01: Parameters {'cert', 'key'} not documented
   
   pyarrow._flight.CallInfo
   -> pyarrow._flight.Information about a particular RPC for Flight middleware.
   PR01: Parameters {'method'} not documented
   
   pyarrow._flight.BasicAuth
   -> pyarrow._flight.BasicAuth(username=None, ***
   PR01: Parameters {'password', 'username'} not documented
   
   pyarrow._flight.deserialize
   -> pyarrow._flight.BasicAuth.deserialize(string)
   PR01: Parameters {'string'} not documented
   
   pyarrow._flight.ActionType
   -> pyarrow._flight.A type of action that is executable on a Flight service.
   PR01: Parameters {'type', 'description'} not documented
   
   pyarrow._flight.Action
   -> pyarrow._flight.Action(action_type, buf)
   PR01: Parameters {'buf', 'action_type'} not documented
   
   pyarrow.lib.schema
   -> pyarrow.lib.schema(fields, metadata=None)
   PR01: Parameters {'fields'} not documented
   
   pyarrow.feather.read_feather
   PR01: Parameters {'use_threads'} not documented
   
   pyarrow.lib.concat_tables
   -> pyarrow.lib.concat_tables(tables, bool promote=False, MemoryPool memory_pool=None)
   PR01: Parameters {'promote'} not documented
   
   pyarrow.lib.is_available
   -> pyarrow.lib.Codec.is_available(unicode compression)
   PR01: Parameters {'compression'} not documented
   
   pyarrow._json.read_json
   -> pyarrow._json.read_json(input_file, read_options=None, parse_options=None, MemoryPool memory_pool=None)
   PR01: Parameters {'memory_pool', 'read_options', 'parse_options', 'input_file'} not documented
   
   pyarrow._json.ParseOptions
   -> pyarrow._json.ParseOptions(explicit_schema=None, newlines_in_values=None, unexpected_field_behavior=None)
   PR01: Parameters {'unexpected_field_behavior', 'explicit_schema', 'newlines_in_values'} not documented
   
   pyarrow.orc.ORCWriter.write
   PR01: Parameters {'table'} not documented
   
   Total number of docstring violations: 186
   ```
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org