d33bs opened a new issue, #41907:
URL: https://github.com/apache/arrow/issues/41907
### Describe the enhancement requested
Thanks for the fantastic work on Arrow and PyArrow! I noticed a minor typo
in the docs for code examples with `RecordBatch.from_pydict()` and
`RecordBatch.from_pylist()` which mention `pa.Table.from_{x}` instead of
`pa.RecordBatch.from_{x}`. This may result in possible user confusion, needing
to look up the source code, or try things out to make sure the Python API can
handle the calls.
For example, under
[`pa.RecordBatch.from_pydict()`](https://arrow.apache.org/docs/python/generated/pyarrow.RecordBatch.html#pyarrow.RecordBatch.from_pydict):
Currently shows:
```text
>>> my_metadata={"n_legs": "Number of legs per animal"}
>>> pa.Table.from_pydict(pydict, metadata=my_metadata).schema
n_legs: int64
animals: string
-- schema metadata --
n_legs: 'Number of legs per animal'
```
Should be:
```text
>>> my_metadata={"n_legs": "Number of legs per animal"}
>>> pa.RecordBatch.from_pydict(pydict, metadata=my_metadata).schema
n_legs: int64
animals: string
-- schema metadata --
n_legs: 'Number of legs per animal'
```
The same stands for examples in
[`pa.RecordBatch.from_pylist()`](https://arrow.apache.org/docs/python/generated/pyarrow.RecordBatch.html#pyarrow.RecordBatch.from_pylist).
Thanks in advance for help with correcting this.
### Component(s)
Documentation, Python
--
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]
