jorisvandenbossche / pydata-amsterdam-pandas-sprint

1 stars 3 forks source link

DOC: document read-only return value in DataFrame/Series.to_numpy #12

Open jorisvandenbossche opened 8 months ago

jorisvandenbossche commented 8 months ago

Current docstring: https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.to_numpy.html#pandas.DataFrame.to_numpy

Behaviour of returning a read-only numpy array is documented here: https://pandas.pydata.org/docs/dev/user_guide/copy_on_write.html#read-only-numpy-arrays

We should mention this in the docstring as well