[Python] Add missing docstrings to Cython functions  #37217

Closed
#37218
Closed
[Python] Add missing docstrings to Cython functions #37217
#37218
Assignees
danepitkin
Labels
Component: PythonType: bug
Milestone
14.0.0

Description

@danepitkin
danepitkin
opened on Aug 16, 2023

Describe the bug, including details regarding any error messages, version, and platform.

The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.

Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:

INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

Component(s)

Python

Metadata

Metadata

Assignees

Labels

Component: PythonType: bug

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
     blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

    Skip to content
    [Python] Add missing docstrings to Cython functions  #37217
    Closed
    #37218
    Closed
    [Python] Add missing docstrings to Cython functions #37217
    #37218
    Assignees
    danepitkin
    Labels
    Component: PythonType: bug
    Milestone
    14.0.0
    Description
    @danepitkin
    danepitkin
    opened on Aug 16, 2023
    Describe the bug, including details regarding any error messages, version, and platform.
    The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
    Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
    INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

    Component(s)
    Python
    Metadata
    Metadata
    Assignees
    Labels
    Component: PythonType: bug
    Type
    No type
    Projects
    No projects
      Milestone
      Relationships
      None yet
      Development
      No branches or pull requests
      Issue actions
      
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

      Skip to content
      [Python] Add missing docstrings to Cython functions  #37217
      Closed
      #37218
      Closed
      [Python] Add missing docstrings to Cython functions #37217
      #37218
      Assignees
      danepitkin
      Labels
      Component: PythonType: bug
      Milestone
      14.0.0
      Description
      @danepitkin
      danepitkin
      opened on Aug 16, 2023
      Describe the bug, including details regarding any error messages, version, and platform.
      The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
      Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
      INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

      Component(s)
      Python
      Metadata
      Metadata
      Assignees
      Labels
      Component: PythonType: bug
      Type
      No type
      Projects
      No projects
        Milestone
        Relationships
        None yet
        Development
        No branches or pull requests
        Issue actions
        
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

        Skip to content
        [Python] Add missing docstrings to Cython functions  #37217
        Closed
        #37218
        Closed
        [Python] Add missing docstrings to Cython functions #37217
        #37218
        Assignees
        danepitkin
        Labels
        Component: PythonType: bug
        Milestone
        14.0.0
        Description
        @danepitkin
        danepitkin
        opened on Aug 16, 2023
        Describe the bug, including details regarding any error messages, version, and platform.
        The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
        Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
        INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

        Component(s)
        Python
        Metadata
        Metadata
        Assignees
        Labels
        Component: PythonType: bug
        Type
        No type
        Projects
        No projects
          Milestone
          Relationships
          None yet
          Development
          No branches or pull requests
          Issue actions
          
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

          Skip to content
          [Python] Add missing docstrings to Cython functions  #37217
          Closed
          #37218
          Closed
          [Python] Add missing docstrings to Cython functions #37217
          #37218
          Assignees
          danepitkin
          Labels
          Component: PythonType: bug
          Milestone
          14.0.0
          Description
          @danepitkin
          danepitkin
          opened on Aug 16, 2023
          Describe the bug, including details regarding any error messages, version, and platform.
          The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
          Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
          INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

          Component(s)
          Python
          Metadata
          Metadata
          Assignees
          Labels
          Component: PythonType: bug
          Type
          No type
          Projects
          No projects
            Milestone
            Relationships
            None yet
            Development
            No branches or pull requests
            Issue actions
            
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

            Skip to content
            [Python] Add missing docstrings to Cython functions  #37217
            Closed
            #37218
            Closed
            [Python] Add missing docstrings to Cython functions #37217
            #37218
            Assignees
            danepitkin
            Labels
            Component: PythonType: bug
            Milestone
            14.0.0
            Description
            @danepitkin
            danepitkin
            opened on Aug 16, 2023
            Describe the bug, including details regarding any error messages, version, and platform.
            The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
            Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
            INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

            Component(s)
            Python
            Metadata
            Metadata
            Assignees
            Labels
            Component: PythonType: bug
            Type
            No type
            Projects
            No projects
              Milestone
              Relationships
              None yet
              Development
              No branches or pull requests
              Issue actions
              
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

              Skip to content
              [Python] Add missing docstrings to Cython functions  #37217
              Closed
              #37218
              Closed
              [Python] Add missing docstrings to Cython functions #37217
              #37218
              Assignees
              danepitkin
              Labels
              Component: PythonType: bug
              Milestone
              14.0.0
              Description
              @danepitkin
              danepitkin
              opened on Aug 16, 2023
              Describe the bug, including details regarding any error messages, version, and platform.
              The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
              Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
              INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

              Component(s)
              Python
              Metadata
              Metadata
              Assignees
              Labels
              Component: PythonType: bug
              Type
              No type
              Projects
              No projects
                Milestone
                Relationships
                None yet
                Development
                No branches or pull requests
                Issue actions
                
, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

                Skip to content
                [Python] Add missing docstrings to Cython functions  #37217
                Closed
                #37218
                Closed
                [Python] Add missing docstrings to Cython functions #37217
                #37218
                Assignees
                danepitkin
                Labels
                Component: PythonType: bug
                Milestone
                14.0.0
                Description
                @danepitkin
                danepitkin
                opened on Aug 16, 2023
                Describe the bug, including details regarding any error messages, version, and platform.
                The Cython 3.0.0 upgrade #37097 is failing to generate numpydocs. There are missing docstrings for many functions that were going unreported before. Let's fix them in a separate PR due to the volume.
                Example here https://github.com/apache/arrow/actions/runs/5868446229/job/15911310413?pr=37097:
                INFO:archery:Running Python docstring linters
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow.gandiva.TreeExprBuilder.make_or
-> pyarrow.gandiva.TreeExprBuilder.make_or(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.TreeExprBuilder.make_literal
-> pyarrow.gandiva.TreeExprBuilder.make_literal(self, value, dtype)
PR01: Parameters {'dtype', 'value'} not documented
pyarrow.gandiva.TreeExprBuilder.make_in_expression
-> pyarrow.gandiva.TreeExprBuilder.make_in_expression(self, Node node, values, dtype)
PR01: Parameters {'node', 'dtype', 'values'} not documented
pyarrow.gandiva.TreeExprBuilder.make_if
-> pyarrow.gandiva.TreeExprBuilder.make_if(self, Node condition, Node this_node, Node else_node, DataType return_type)
PR01: Parameters {'return_type', 'condition', 'this_node', 'else_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_function
-> pyarrow.gandiva.TreeExprBuilder.make_function(self, name, children, DataType return_type)
PR01: Parameters {'return_type', 'children', 'name'} not documented
pyarrow.gandiva.TreeExprBuilder.make_field
-> pyarrow.gandiva.TreeExprBuilder.make_field(self, Field field)
PR01: Parameters {'field'} not documented
pyarrow.gandiva.TreeExprBuilder.make_expression
-> pyarrow.gandiva.TreeExprBuilder.make_expression(self, Node root_node, Field return_field)
PR01: Parameters {'return_field', 'root_node'} not documented
pyarrow.gandiva.TreeExprBuilder.make_condition
-> pyarrow.gandiva.TreeExprBuilder.make_condition(self, Node condition)
PR01: Parameters {'condition'} not documented
pyarrow.gandiva.TreeExprBuilder.make_and
-> pyarrow.gandiva.TreeExprBuilder.make_and(self, children)
PR01: Parameters {'children'} not documented
pyarrow.gandiva.Projector.evaluate
-> pyarrow.gandiva.Projector.evaluate(self, RecordBatch batch, SelectionVector selection=None)
PR01: Parameters {'selection', 'batch'} not documented
pyarrow.gandiva.Filter.evaluate
-> pyarrow.gandiva.Filter.evaluate(self, RecordBatch batch, MemoryPool pool, dtype=u'int32')
PR01: Parameters {'dtype', 'batch', 'pool'} not documented
pyarrow._dataset.Partitioning.parse
-> pyarrow._dataset.Partitioning.parse(self, path)
PR01: Parameters {'path'} not documented
pyarrow._dataset_parquet.ParquetReadOptions.equals
-> pyarrow._dataset_parquet.ParquetReadOptions.equals(self, ParquetReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals
-> pyarrow._dataset_parquet.ParquetFragmentScanOptions.equals(self, ParquetFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_parquet.ParquetFileWriteOptions.update
-> pyarrow._dataset_parquet.ParquetFileWriteOptions.update(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.make_write_options
-> pyarrow._dataset_parquet.ParquetFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset_parquet.ParquetFileFormat.equals
-> pyarrow._dataset_parquet.ParquetFileFormat.equals(self, ParquetFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset_orc.OrcFileFormat.equals
-> pyarrow._dataset_orc.OrcFileFormat.equals(self, OrcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFragmentScanOptions.equals
-> pyarrow._dataset.JsonFragmentScanOptions.equals(self, JsonFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.JsonFileFormat.equals
-> pyarrow._dataset.JsonFileFormat.equals(self, JsonFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.IpcFileFormat.make_write_options
-> pyarrow._dataset.IpcFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.IpcFileFormat.equals
-> pyarrow._dataset.IpcFileFormat.equals(self, IpcFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.type.FileSystemDataset.from_paths
-> pyarrow._dataset.FileSystemDataset.from_paths(cls, paths, schema=None, format=None, filesystem=None, partitions=None, root_partition=None)
PR01: Parameters {'format', 'filesystem', 'root_partition', 'schema', 'partitions'} not documented
pyarrow._compute.Expression.equals
-> pyarrow._compute.Expression.equals(self, Expression other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFragmentScanOptions.equals
-> pyarrow._dataset.CsvFragmentScanOptions.equals(self, CsvFragmentScanOptions other)
PR01: Parameters {'other'} not documented
pyarrow._dataset.CsvFileFormat.make_write_options
-> pyarrow._dataset.CsvFileFormat.make_write_options(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._dataset.CsvFileFormat.equals
-> pyarrow._dataset.CsvFileFormat.equals(self, CsvFileFormat other)
PR01: Parameters {'other'} not documented
pyarrow._json.ReadOptions.equals
-> pyarrow._json.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._json.ParseOptions.equals
-> pyarrow._json.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._fs.FileSystem.equals
-> pyarrow._fs.FileSystem.equals(self, FileSystem other)
PR01: Parameters {'other'} not documented
pyarrow._s3fs.S3LogLevel
-> pyarrow._s3fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow._fs.FileType
-> pyarrow._fs.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.DataType.field
-> pyarrow.lib.DataType.field(self, i) -> Field
PR01: Parameters {'i'} not documented
pyarrow.lib.Scalar.equals
-> pyarrow.lib.Scalar.equals(self, Scalar other)
PR01: Parameters {'other'} not documented
pyarrow.lib.Array.format
-> pyarrow.lib.Array.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow.lib.Array.equals
-> pyarrow.lib.Array.equals(self, Array other)
PR01: Parameters {'other'} not documented
pyarrow.lib.UnionArray.child
-> pyarrow.lib.UnionArray.child(self, int pos)
PR01: Parameters {'pos'} not documented
pyarrow.lib.NativeFile.writelines
-> pyarrow.lib.NativeFile.writelines(self, lines)
PR01: Parameters {'lines'} not documented
pyarrow.lib.NativeFile.read_buffer
-> pyarrow.lib.NativeFile.read_buffer(self, nbytes=None)
PR01: Parameters {'nbytes'} not documented
pyarrow.lib.SparseCSRMatrix.dim_name
-> pyarrow.lib.SparseCSRMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSFTensor.from_dense_numpy
-> pyarrow.lib.SparseCSFTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSFTensor.dim_name
-> pyarrow.lib.SparseCSFTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCSCMatrix.from_dense_numpy
-> pyarrow.lib.SparseCSCMatrix.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCSCMatrix.dim_name
-> pyarrow.lib.SparseCSCMatrix.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.type.SparseCOOTensor.from_dense_numpy
-> pyarrow.lib.SparseCOOTensor.from_dense_numpy(cls, obj, dim_names=None)
PR01: Parameters {'dim_names', 'obj'} not documented
pyarrow.lib.SparseCOOTensor.dim_name
-> pyarrow.lib.SparseCOOTensor.dim_name(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.PythonFile.truncate
-> pyarrow.lib.PythonFile.truncate(self, pos=None)
PR01: Parameters {'pos'} not documented
pyarrow.lib.PythonFile.readlines
-> pyarrow.lib.PythonFile.readlines(self, hint=None)
PR01: Parameters {'hint'} not documented
pyarrow.lib.PythonFile.readline
-> pyarrow.lib.PythonFile.readline(self, size=None)
PR01: Parameters {'size'} not documented
pyarrow.lib.MetadataVersion
-> pyarrow.lib.An enumeration.
PR01: Parameters {'value', 'names', 'module', 'qualname', 'start', 'type'} not documented
pyarrow.lib.KeyValueMetadata.value
-> pyarrow.lib.KeyValueMetadata.value(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.key
-> pyarrow.lib.KeyValueMetadata.key(self, i)
PR01: Parameters {'i'} not documented
pyarrow.lib.KeyValueMetadata.get_all
-> pyarrow.lib.KeyValueMetadata.get_all(self, key)
PR01: Parameters {'key'} not documented
pyarrow.lib.KeyValueMetadata.equals
-> pyarrow.lib.KeyValueMetadata.equals(self, KeyValueMetadata other)
PR01: Parameters {'other'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threshold(self, int64_t threshold)
PR01: Parameters {'threshold'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_threads(self, int num_threads)
PR01: Parameters {'num_threads'} not documented
pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize
-> pyarrow.lib.FixedSizeBufferWriter.set_memcopy_blocksize(self, int64_t blocksize)
PR01: Parameters {'blocksize'} not documented
pyarrow.lib.ChunkedArray.format
-> pyarrow.lib.ChunkedArray.format(self, **kwargs)
PR01: Parameters {'**kwargs'} not documented
pyarrow._parquet.ParquetReader.set_use_threads
-> pyarrow._parquet.ParquetReader.set_use_threads(self, bool use_threads)
PR01: Parameters {'use_threads'} not documented
pyarrow._parquet.ParquetReader.set_batch_size
-> pyarrow._parquet.ParquetReader.set_batch_size(self, int64_t batch_size)
PR01: Parameters {'batch_size'} not documented
pyarrow._parquet.ParquetReader.scan_contents
-> pyarrow._parquet.ParquetReader.scan_contents(self, column_indices=None, batch_size=65536)
PR01: Parameters {'batch_size', 'column_indices'} not documented
pyarrow._parquet.ParquetReader.read_row_groups
-> pyarrow._parquet.ParquetReader.read_row_groups(self, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'row_groups', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_row_group
-> pyarrow._parquet.ParquetReader.read_row_group(self, int i, column_indices=None, bool use_threads=True)
PR01: Parameters {'i', 'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.read_column
-> pyarrow._parquet.ParquetReader.read_column(self, int column_index)
PR01: Parameters {'column_index'} not documented
pyarrow._parquet.ParquetReader.read_all
-> pyarrow._parquet.ParquetReader.read_all(self, column_indices=None, bool use_threads=True)
PR01: Parameters {'column_indices', 'use_threads'} not documented
pyarrow._parquet.ParquetReader.open
-> pyarrow._parquet.ParquetReader.open(self, source, *, bool use_memory_map=False, read_dictionary=None, FileMetaData metadata=None, int buffer_size=0, bool pre_buffer=False, coerce_int96_timestamp_unit=None, FileDecryptionProperties decryption_properties=None, thrift_string_size_limit=None, thrift_container_size_limit=None)
PR01: Parameters {'thrift_string_size_limit', 'use_memory_map', 'thrift_container_size_limit', 'pre_buffer', 'source', 'read_dictionary', 'metadata', 'decryption_properties', 'buffer_size', 'coerce_int96_timestamp_unit'} not documented
pyarrow._parquet.ParquetReader.iter_batches
-> pyarrow._parquet.ParquetReader.iter_batches(self, int64_t batch_size, row_groups, column_indices=None, bool use_threads=True)
PR01: Parameters {'row_groups', 'use_threads', 'batch_size', 'column_indices'} not documented
pyarrow._csv.ReadOptions.equals
-> pyarrow._csv.ReadOptions.equals(self, ReadOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ParseOptions.equals
-> pyarrow._csv.ParseOptions.equals(self, ParseOptions other)
PR01: Parameters {'other'} not documented
pyarrow._csv.ConvertOptions.equals
-> pyarrow._csv.ConvertOptions.equals(self, ConvertOptions other)
PR01: Parameters {'other'} not documented
Total number of docstring violations: 72

                Component(s)
                Python
                Metadata
                Metadata
                Assignees
                Labels
                Component: PythonType: bug
                Type
                No type
                Projects
                No projects
                  Milestone
                  Relationships
                  None yet
                  Development
                  No branches or pull requests
                  Issue actions