Skip to content

docs: clarify list forms of DataArray coords #11492

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
Whning0513 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −5
Open

docs: clarify list forms of DataArray coords #11492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions doc/user-guide/data-structures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,12 @@ The {py:class}`~xarray.DataArray` constructor takes:
- `data`: a multi-dimensional array of values (e.g., a numpy ndarray,
a {ref}`numpy-like array <userguide.duckarrays>`, {py:class}`~pandas.Series`,
{py:class}`~pandas.DataFrame` or `pandas.Panel`)
- `coords`: a list or dictionary of coordinates. If a list, it should be a
list of tuples where the first element is the dimension name and the second
element is the corresponding coordinate array_like object.
- `dims`: a list of dimension names. If omitted and `coords` is a list of
tuples, dimension names are taken from `coords`.
- `coords`: a list or dictionary of coordinates. A list may contain tuples whose
first element is the dimension name and whose second element is the corresponding
coordinate array-like object. It may also contain coordinate arrays when `dims`
is provided; in that case, coordinates are matched to dimensions by position.
- `dims`: a list of dimension names. If omitted and `coords` is a list of tuples,
dimension names are taken from `coords`.
- `attrs`: a dictionary of attributes to add to the instance
- `name`: a string that names the instance

Expand Down
Loading