Skip to content

Fix DataArray.copy documentation: remove confusing mention of 'dataset' (Gh3606) #4245

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 4 commits into from
Jul 24, 2020
Merged

Fix DataArray.copy documentation: remove confusing mention of 'dataset' (Gh3606) #4245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6db4570
Docs: improve `dataarray.copy` docstring + solves GH3606
sjvrijn Jul 21, 2020
5687e32
updated whats-new
sjvrijn Jul 21, 2020
5918bde
moved whats-new to correct location
sjvrijn Jul 22, 2020
0ae1e67
Merge branch 'master' into GH3606
dcherian Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ Bug fixes

Documentation
~~~~~~~~~~~~~
- removed skipna argument from :py:meth:`DataArray.count`, any, all. (:issue:`755`)

- update the docstring of :py:meth:`DataArray.copy` to remove incorrect mention of 'dataset' (:issue:`3606`)
By `Sander van Rijn <https://github.com/sjvrijn>`_.
- removed skipna argument from :py:meth:`DataArray.count`, :py:meth:`DataArray.any`, :py:meth:`DataArray.all`. (:issue:`755`)
By `Sander van Rijn <https://github.com/sjvrijn>`_

Internal Changes
Expand Down
4 changes: 2 additions & 2 deletions xarray/core/dataarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,8 +862,8 @@ def copy(self, deep: bool = True, data: Any = None) -> "DataArray":
"""Returns a copy of this array.

If `deep=True`, a deep copy is made of the data array.
Otherwise, a shallow copy is made, so each variable in the new
array's dataset is also a variable in this array's dataset.
Otherwise, a shallow copy is made, and the returned data array's
values are a new view of this data array's values.

Use `data` to create a new object with the same structure as
original but entirely new data.
Expand Down