DOC: update Series() docstring about copy behaviour #63341
Conversation
| The name to give to the Series. | ||
| copy : bool, default False | ||
| Copy input data. Only affects Series or 1d ndarray input. See examples. | ||
| copy : bool, default None |
There was a problem hiding this comment.
Related to #63144, the question is what to put here in the docstring ..
copy=None is closest to what is in the signature, but is not really meaningful by itself. Of course, the behaviour also depends on the intput, so writing that it defaults to either True or False will also be misleading for some cases.
(eg the current default False in the docstring above is not correct for array input)
There was a problem hiding this comment.
I'm fine with None here, I think the behavior is too complex to give a meaningful description in the space allowed.
| Whether to copy input data. Only affects array or Series/Index input, | ||
| because for other input (e.g. a list) a new array is created anyway. | ||
| By default, will copy if the input data is a numpy or pandas array. | ||
| For Series/Index input, a shallow copy of the data is made by default. |
There was a problem hiding this comment.
It's not quite clear to me what happens if you set it to False in the Series/Index case.
| because for other input (e.g. a list) a new array is created anyway. | ||
| By default, will copy if the input data is a numpy or pandas array. | ||
| For Series/Index input, a shallow copy of the data is made by default. | ||
| Set to False to avoid copying array input, at your own risk (if you |
There was a problem hiding this comment.
nit: no comma.
| Set to False to avoid copying array input, at your own risk (if you | |
| Set to False to avoid copying array input at your own risk (if you |
| The name to give to the Series. | ||
| copy : bool, default False | ||
| Copy input data. Only affects Series or 1d ndarray input. See examples. | ||
| copy : bool, default None |
There was a problem hiding this comment.
I'm fine with None here, I think the behavior is too complex to give a meaningful description in the space allowed.
2 participants
No description provided.