Add "rows" as option to "axis" docstring #46841
Closed
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
The "axis" parameter of
pd.concat()can take the string'rows'as an optional way of explicitly defining the default row axis for concatenation:Using
'rows'instead of'index'or0might be more intuitive as a counterpart to'columns'. In any case, it's a possible option, so it might be helpful to represent that in the docstring.The proposed update in the docstring uses the suggested format based on pandas docstring guide:
https://pandas.pydata.org/docs/dev/development/contributing_docstring.html#parameter-types
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.