rok commented on code in PR #46354:
URL: https://github.com/apache/arrow/pull/46354#discussion_r2079577180
##########
python/pyarrow/ipc.py:
##########
@@ -109,11 +109,16 @@ class RecordBatchFileWriter(lib._RecordBatchFileWriter):
__doc__ = """Writer to create the Arrow binary file format
-{}""".format(_ipc_writer_class_doc)
+{}
+metadata : dict | pyarrow.KeyValueMetadata, optional
+ Key/value pairs (both **must** be bytes-like) that will be stored
+ in the file footer and are retrievable with
+ ``ipc.open_file(...).metadata``.
+""".format(_ipc_writer_class_doc)
Review Comment:
Docstring produced now doesn't seem to [sit well with the
linter](https://github.com/apache/arrow/actions/runs/14888211833/job/41866015539?pr=46354#step:6:8647):
```python
INFO:archery:Running Python docstring linters
/opt/conda/envs/arrow/lib/python3.10/site-packages/numpydoc/docscrape.py:418:
UserWarning: Unknown section Example
warn(msg)
pyarrow.ipc.new_file
-> pyarrow.ipc.Create an Arrow columnar IPC file writer instance
PR01: Parameters {'metadata'} not documented
Total number of docstring violations: 1
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
