Closed
Description
Pandas version checks
- I have checked that the issue still exists on the latest versions of the docs on
main
here
Location of the documentation
https://pandas.pydata.org/docs/dev/reference/api/pandas.concat.html#pandas.concat
Documentation problem
The first part of the documentation for the sort
argument in pd.concat
is confusing and incorrect.
Sort non-concatenation axis if it is not already aligned.
It wasn't clear to me if the result df
would be sorted if the df
's being concatenated were already aligned (but not sorted). I had to manually confirm.
I suspect the wording originated from this bug #4588
Which added FutureWarning: Sorting because non-concatenation axis is not aligned. A future version of pandas will change to not sort by default.
Suggested fix for documentation
Remove the if it is not already aligned
part.