DOC: document read_orc columns order behaviour #49709
Conversation
pandas/io/orc.py
Outdated
| @@ -47,6 +47,8 @@ def read_orc( | |||
| ``file://localhost/path/to/table.orc``. | |||
| columns : list, default None | |||
| If not None, only these columns will be read from the file. | |||
| Output always follows the ordering of the file and not the columns list. | |||
| This mirrors the original behaviour of :func:`pyarrow.orc.OrcFile.read`. | |||
There was a problem hiding this comment.
Sure. Please suggest any improvement.
There was a problem hiding this comment.
I was thinking about adding ~ to the link, could you try that?
There was a problem hiding this comment.
I think https://github.com/pandas-dev/pandas/pull/49709/files#r1024350615 should allow the read sphinx link should allow it to render & link to the pyarrow docs
There was a problem hiding this comment.
Maybe it's worth opening another issue for adding links to all references to pyarrow (only in the docstring).
pandas.io.orc.to_orc is also missing external+pyarrow.
Line 107 in 2455f88
There was a problem hiding this comment.
Sounds good, could you open an issue?
There was a problem hiding this comment.
I double-checked and they all seem to correctly link to external documentation.
E.g. param engine_kwargs for DataFrame.to_orc: it has a link to pyarrow, but in the source-code it doesn't have external+pyarrow in front.
So we should be good.
mroeschke
added
Docs
IO Data
|
thx @markopacak |
columnsis not preserved inpd.read_orc#47944doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.