DOC: Document return type from concat #17953
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For a single Series. Closes pandas-dev#17952
pandas/core/reshape/concat.py
Outdated
| @@ -66,6 +66,9 @@ def concat(objs, axis=0, join='outer', join_axes=None, ignore_index=False, | |||
| Returns | |||
| ------- | |||
| concatenated : object, type of objs | |||
| When concatenating all ``Series`` along the index, a ``Series`` is | |||
| returned. When ``objs`` includes at least one ``DataFrame`` or when | |||
| concatenating along the columns, a ``DataFrame`` is returned. | |||
There was a problem hiding this comment.
I would maybe make the "concatenating along the columns" a separate case (so new sentence). Like "Concatenating along the columns (axis=1) always results in a DataFrame"
Codecov Report
@@ Coverage Diff @@
## master #17953 +/- ##
==========================================
- Coverage 91.23% 91.22% -0.02%
==========================================
Files 163 163
Lines 50113 50113
==========================================
- Hits 45723 45714 -9
- Misses 4390 4399 +9
Continue to review full report at Codecov.
|
|
lgtm. you might want to also update merge.rst (it shows the doc-string there as well) |
peterpanmj
pushed a commit
to peterpanmj/pandas
that referenced
this pull request
Oct 31, 2017
* DOC: Document return type from concat For a single Series. Closes pandas-dev#17952 * Reword
No-Stream
pushed a commit
to No-Stream/pandas
that referenced
this pull request
Nov 28, 2017
* DOC: Document return type from concat For a single Series. Closes pandas-dev#17952 * Reword
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For a single Series with axis=1.
Closes #17952