issues: 485390288
This data as json
| id | node_id | number | title | user | state | locked | assignee | milestone | comments | created_at | updated_at | closed_at | author_association | active_lock_reason | draft | pull_request | body | reactions | performed_via_github_app | state_reason | repo | type |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 485390288 | MDU6SXNzdWU0ODUzOTAyODg= | 3264 | Clarify documentation of argmin/argmax | 13667821 | closed | 0 | 5 | 2019-08-26T18:57:42Z | 2020-08-18T17:57:43Z | 2020-08-18T17:57:43Z | CONTRIBUTOR | The documentation pages only refer to argmin/argmax without defining them (e.g. "Returns: New DataArray object with argmin applied to its data"), forcing users to refer to the NumPy documentation to learn what the functions do do and try to guess at how the XArray version will work. I think the doc pages should say what these functions actually do, possibly with an example of a common use case, e.g. finding the latitude where some quantity is minimized. Also, the first time I used argmin/argmax I wasn't sure from the documentation whether the returned value is the coordinate index or the raw index. I think this should be explicitly stated. I also like the idea mentioned in issue #1388 of creating an alternate version of argmin/argmax that does return the coordinate index, since it would make it easier to stay within the coordinate indices all the time. |
{
"url": "https://api.github.com/repos/pydata/xarray/issues/3264/reactions",
"total_count": 0,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
} |
completed | 13221727 | issue |