You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2020/07/13 15:45:32 UTC

[GitHub] [arrow] kszucs opened a new pull request #7732: [Python][CI] Create a build for validating python docstrings

kszucs opened a new pull request #7732:
URL: https://github.com/apache/arrow/pull/7732


   Using the existing numpydoc checker in archery. I've enabled a single rule to check undocumented arguments.


----------------------------------------------------------------
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.

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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#discussion_r764673681



##########
File path: dev/archery/setup.py
##########
@@ -36,6 +36,7 @@
                  'setuptools_scm'],
     'crossbow-upload': ['github3.py', jinja_req, 'ruamel.yaml',
                         'setuptools_scm'],
+    'numpydoc': ['numpydoc==1.1.0']

Review comment:
       This it the first version which provides the class and function we use from numpydoc which seem a bit like internal-ish at the moment. 




-- 
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



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

Posted by GitBox <gi...@apache.org>.
amol- commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-879868157


   A good first step might be to ensure no new ones can be added. In other contexts I used to `wc -l` the output of flake8 _before_ and _after_ the PR (thus on master and on the PR) to ensure that the PR didn't introduce any _new_ error.
   
   A similar strategy might be applied here, while we fix the existing ones, we can put in place a check that prevents new ones from occurring by simply counting the number of existing errors (or if you want to go further you can compare the list of functions with errors, but In my experience just comparing the count does 90% of the job)


-- 
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



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

Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-988710987


   Benchmark runs are scheduled for baseline = b31dd5148e0e0b55555c7a9417e83a08949e9d4b and contender = 2bffb82a0da704510b25cacd3ecec819f752fb59. 2bffb82a0da704510b25cacd3ecec819f752fb59 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/41dfaff8969b4c8c960b1fe2bbd4553a...8e2c4da5b32a4af7b6663a8d41459152/)
   [Finished :arrow_down:0.74% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/fd38043a7eb44e5689ecb13a177c188a...f356a5f8c51a4070888963550009d54d/)
   [Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/e6c8f5f5e7e249b2a3a877dcb81d508a...7f768c9ec6b04badbd14a3b7e51f6959/)
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870503520


   We have many undocumented arguments in the pyarrow API. It would be nice if we could introduce the numpydoc checks, but at some point we need to enable at least a single rule causing the build to fail.
   
   cc @pitrou @jorisvandenbossche @amol 


-- 
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



[GitHub] [arrow] github-actions[bot] removed a comment on pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
github-actions[bot] removed a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-657640362


   <!--
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
   -->
   
   Thanks for opening a pull request!
   
   Could you open an issue for this pull request on JIRA?
   https://issues.apache.org/jira/browse/ARROW
   
   Then could you also rename pull request title in the following format?
   
       ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}
   
   See also:
   
     * [Other pull requests](https://github.com/apache/arrow/pulls/)
     * [Contribution Guidelines - How to contribute patches](https://arrow.apache.org/docs/developers/contributing.html#how-to-contribute-patches)
   


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#discussion_r763184457



##########
File path: dev/archery/archery/utils/lint.py
##########
@@ -246,7 +246,7 @@ def python_numpydoc(symbols=None, allow_rules=None, disallow_rules=None):
         'pyarrow.csv',
         'pyarrow.dataset',
         'pyarrow.feather',
-        'pyarrow.flight',
+        # 'pyarrow.flight',

Review comment:
       Temporarily disabled, created a follow-up: https://issues.apache.org/jira/browse/ARROW-14995




-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-987284205


   cc @amol- 


-- 
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



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

Posted by 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



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

Posted by GitBox <gi...@apache.org>.
pitrou commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870742773


   @kszucs Why not. Is there a way to selectively disable the check on some functions? (a Python comment perhaps?)


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-871726097


   ```
   ...
   
   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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870503520


   We have many undocumented arguments in the pyarrow API. It would be nice if we could introduce the numpydoc checks, but at some point we need to enable at least a single rule causing the build to fail.
   
   cc @pitrou @jorisvandenbossche @amol 


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs closed pull request #7732:
URL: https://github.com/apache/arrow/pull/7732


   


-- 
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



[GitHub] [arrow] github-actions[bot] commented on pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870471692


   https://issues.apache.org/jira/browse/ARROW-13208


-- 
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



[GitHub] [arrow] github-actions[bot] commented on pull request #7732: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-657640362


   <!--
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
   -->
   
   Thanks for opening a pull request!
   
   Could you open an issue for this pull request on JIRA?
   https://issues.apache.org/jira/browse/ARROW
   
   Then could you also rename pull request title in the following format?
   
       ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}
   
   See also:
   
     * [Other pull requests](https://github.com/apache/arrow/pulls/)
     * [Contribution Guidelines - How to contribute patches](https://arrow.apache.org/docs/developers/contributing.html#how-to-contribute-patches)
   


----------------------------------------------------------------
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.

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



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

Posted by GitBox <gi...@apache.org>.
pitrou commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870743022


   @kszucs Can you paste the current error log somewhere?


-- 
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



[GitHub] [arrow] pitrou commented on a change in pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#discussion_r764093278



##########
File path: python/pyarrow/compat.pxi
##########
@@ -52,13 +52,31 @@ except ImportError:
 
 
 def tobytes(o):
+    """
+    Return with the byte representation of the string-like input object.

Review comment:
       ```suggestion
       Encode a unicode or bytes string to bytes.
   ```

##########
File path: python/pyarrow/compat.pxi
##########
@@ -52,13 +52,31 @@ except ImportError:
 
 
 def tobytes(o):
+    """
+    Return with the byte representation of the string-like input object.
+
+    Parameters
+    ----------
+    o : bytes-like
+        Input object.
+    """
     if isinstance(o, str):
         return o.encode('utf8')
     else:
         return o
 
 
 def frombytes(o, *, safe=False):
+    """
+    Return with the unicode string representation of a bytes-like object.
+
+    Parameters
+    ----------
+    o : bytes-like
+        Input object.
+    safe : bool, default False
+        Raise on encoding errors.

Review comment:
       ```suggestion
           If true, raise on encoding errors.
   ```

##########
File path: dev/archery/setup.py
##########
@@ -36,6 +36,7 @@
                  'setuptools_scm'],
     'crossbow-upload': ['github3.py', jinja_req, 'ruamel.yaml',
                         'setuptools_scm'],
+    'numpydoc': ['numpydoc==1.1.0']

Review comment:
       Is there a particular reason for pinning to this exact version?

##########
File path: python/pyarrow/compat.pxi
##########
@@ -52,13 +52,31 @@ except ImportError:
 
 
 def tobytes(o):
+    """
+    Return with the byte representation of the string-like input object.
+
+    Parameters
+    ----------
+    o : bytes-like
+        Input object.

Review comment:
       ```suggestion
           Input string.
   ```

##########
File path: python/pyarrow/compat.pxi
##########
@@ -52,13 +52,31 @@ except ImportError:
 
 
 def tobytes(o):
+    """
+    Return with the byte representation of the string-like input object.
+
+    Parameters
+    ----------
+    o : bytes-like
+        Input object.
+    """
     if isinstance(o, str):
         return o.encode('utf8')
     else:
         return o
 
 
 def frombytes(o, *, safe=False):
+    """
+    Return with the unicode string representation of a bytes-like object.

Review comment:
       ```suggestion
       Decode the given bytestring to unicode.
   ```




-- 
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



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

Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-988710987


   Benchmark runs are scheduled for baseline = b31dd5148e0e0b55555c7a9417e83a08949e9d4b and contender = 2bffb82a0da704510b25cacd3ecec819f752fb59. 2bffb82a0da704510b25cacd3ecec819f752fb59 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/41dfaff8969b4c8c960b1fe2bbd4553a...8e2c4da5b32a4af7b6663a8d41459152/)
   [Finished :arrow_down:0.74% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/fd38043a7eb44e5689ecb13a177c188a...f356a5f8c51a4070888963550009d54d/)
   [Finished :arrow_down:0.0% :arrow_up:0.0%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/e6c8f5f5e7e249b2a3a877dcb81d508a...7f768c9ec6b04badbd14a3b7e51f6959/)
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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



[GitHub] [arrow] github-actions[bot] removed a comment on pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
github-actions[bot] removed a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-657640362


   <!--
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
   -->
   
   Thanks for opening a pull request!
   
   Could you open an issue for this pull request on JIRA?
   https://issues.apache.org/jira/browse/ARROW
   
   Then could you also rename pull request title in the following format?
   
       ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}
   
   See also:
   
     * [Other pull requests](https://github.com/apache/arrow/pulls/)
     * [Contribution Guidelines - How to contribute patches](https://arrow.apache.org/docs/developers/contributing.html#how-to-contribute-patches)
   


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#discussion_r763187191



##########
File path: python/pyarrow/gandiva.pyx
##########
@@ -440,26 +446,70 @@ cdef class TreeExprBuilder(_Weakrefable):
             condition.node)
         return Condition.create(r)
 
+
 cpdef make_projector(Schema schema, children, MemoryPool pool,
                      str selection_mode="NONE"):
-    cdef c_vector[shared_ptr[CExpression]] c_children
-    cdef Expression child
+    """
+    Construct a projection using expressions.
+
+    A projector is built for a specific schema and vector of expressions.
+    Once the projector is built, it can be used to evaluate many row batches.
+
+    Parameters
+    ----------
+    schema : pyarrow.Schema
+        Schema for the record batches, and the expressions.
+    children : list[pyarrow.gandiva.Expression]
+        List of projectable expression objects.
+    pool : pyarrow.MemoryPool
+        Memory pool used to allocate output arrays.
+    selection_mode : str, default "NONE"
+        Possible values are NONE, UINT16, UINT32, UINT64.
+
+    Returns
+    -------
+    Projector instance
+    """
+    cdef:
+        Expression child
+        c_vector[shared_ptr[CExpression]] c_children
+        shared_ptr[CProjector] result
+
     for child in children:
         c_children.push_back(child.expression)
-    cdef shared_ptr[CProjector] result
+
     check_status(
         Projector_Make(schema.sp_schema, c_children,
                        _ensure_selection_mode(selection_mode),
                        CConfigurationBuilder.DefaultConfiguration(),
                        &result))
     return Projector.create(result, pool)
 
+
 cpdef make_filter(Schema schema, Condition condition):

Review comment:
       These functions are only used from the unittest, so we should not expose them to the public API.
   
   Created a follow-up https://issues.apache.org/jira/browse/ARROW-14996




-- 
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



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

Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-988710987


   Benchmark runs are scheduled for baseline = b31dd5148e0e0b55555c7a9417e83a08949e9d4b and contender = 2bffb82a0da704510b25cacd3ecec819f752fb59. 2bffb82a0da704510b25cacd3ecec819f752fb59 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/41dfaff8969b4c8c960b1fe2bbd4553a...8e2c4da5b32a4af7b6663a8d41459152/)
   [Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/fd38043a7eb44e5689ecb13a177c188a...f356a5f8c51a4070888963550009d54d/)
   [Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/e6c8f5f5e7e249b2a3a877dcb81d508a...7f768c9ec6b04badbd14a3b7e51f6959/)
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-871727439


   > @kszucs Why not. Is there a way to selectively disable the check on some functions? (a Python comment perhaps?)
   
   It retrieves data from the python symbols rather than parsing the source files. Otherwise we can maintain a list of symbols (modules for example) to ignore as well as a list to traverse at the first place.


-- 
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



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

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-987815458


   Created a follow up to iteratively fix and enable more numpydoc checks https://issues.apache.org/jira/browse/ARROW-15006


-- 
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



[GitHub] [arrow] pitrou commented on a change in pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#discussion_r764093714



##########
File path: python/pyarrow/compat.pxi
##########
@@ -52,13 +52,31 @@ except ImportError:
 
 
 def tobytes(o):
+    """
+    Return with the byte representation of the string-like input object.
+
+    Parameters
+    ----------
+    o : bytes-like

Review comment:
       ```suggestion
       o : str or bytes
   ```




-- 
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



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

Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-988710987


   Benchmark runs are scheduled for baseline = b31dd5148e0e0b55555c7a9417e83a08949e9d4b and contender = 2bffb82a0da704510b25cacd3ecec819f752fb59. 2bffb82a0da704510b25cacd3ecec819f752fb59 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/41dfaff8969b4c8c960b1fe2bbd4553a...8e2c4da5b32a4af7b6663a8d41459152/)
   [Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/fd38043a7eb44e5689ecb13a177c188a...f356a5f8c51a4070888963550009d54d/)
   [Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/e6c8f5f5e7e249b2a3a877dcb81d508a...7f768c9ec6b04badbd14a3b7e51f6959/)
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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



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

Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-872247878


   Note that several of the "errors" in the output come from not using a space before the colon (`param: type` instead of `param : type`), and are not actually undocumented
   
   > Otherwise we can maintain a list of symbols (modules for example) to ignore as well as a list to traverse at the first place.
   
   I think your archery command allows to specify which modules to test? So we can start with selectively only testing the ones that pass. 
   (that still doesn't allow skipping a specific function, though, in case there would be a good reason you want to skip some function)


-- 
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



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

Posted by GitBox <gi...@apache.org>.
pitrou commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-884293278


   @kszucs Can you rebase and fix conflicts?


-- 
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



[GitHub] [arrow] github-actions[bot] commented on pull request #7732: ARROW-13208: [Python][CI] Create a build for validating python docstrings

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #7732:
URL: https://github.com/apache/arrow/pull/7732#issuecomment-870471692


   https://issues.apache.org/jira/browse/ARROW-13208


-- 
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