DOC: Updated docstring for Series.str.cat (pandas-dev#35556) #35784
Conversation
Updating my fork
Updating my fork
|
I tried to figure out the cause of the two Azure pipeline tests failing, but could not understand how that would be caused by a change in the docstring. |
|
Hi @souris-dev - this is off to a good start, if it's still active could you address Will's comments please? |
|
My apologies for the tardiness (was a bit busy the past week), I'll make the changes and commit in a day. Thanks. |
| @@ -2466,7 +2474,27 @@ def cat(self, others=None, sep=None, na_rep=None, join="left"): | |||
| 2 -c | |||
| dtype: object | |||
|
|
|||
| For more examples, see :ref:`here <text.concatenate>`. | |||
| When `others` is a Series/Index/DataFrame, it is advisable | |||
There was a problem hiding this comment.
you need to explain why one should do this. e.g. to have alignment since the join is defaulting to left.
show an example first with index and index, then index and series of the index and it should be more clear.
| For more examples, see :ref:`here <text.concatenate>`. | ||
| When `others` is a Series/Index/DataFrame, it is advisable | ||
| to use `to_numpy()` while passing it to the function to | ||
| avoid unexpected results. |
There was a problem hiding this comment.
remove the 'unexpected results'.
| Notes | ||
| ----- | ||
| Since version 1.0.0, index alignment is performed when | ||
| `others` is a Series/Index/DataFrame (or a list-like containing |
There was a problem hiding this comment.
is this true for an Index? If the behavior is anything like arithmetic, we would do alignment for Series/DataFrame, but Index would behave more like ndarray
| to use `to_numpy()` while passing it to the function to | ||
| avoid unexpected results. | ||
|
|
||
| The following example demostrates this: |
There was a problem hiding this comment.
this and the next paragraph both end in colons. is this paragraph needed?
|
|
||
| >>> idx = pd.Index(["a", "b", "c", "d", "e"]) | ||
| >>> ser = pd.Series(["f", "g", "h", "i", "j"]) | ||
| >>> idx.str.cat(ser) # the caller is an Index here |
There was a problem hiding this comment.
one more space before the #
|
This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this. |
There was a problem hiding this comment.
@souris-dev are you interested in continuing? If yes address comments and we'll take another look
|
Sorry for the delay, I'm in the process of addressing the comments and will update soon. |
|
Closing for now. @souris-dev let us know whenever you'd like to continue and we'll reopen! |
.str.catoutput in case ofIndexobject #35556black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffI have updated the docstring for
Series.str.catto make the issue in #35556 more explicit to the user.