issues: 1363524666

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
1363524666 PR_kwDOAMm_X84-c82D 6999 Raise UserWarning when rename creates a new dimension coord 4160723 closed 0     2 2022-09-06T16:16:17Z 2022-12-08T09:38:13Z 2022-09-27T09:33:40Z MEMBER   0 pydata/xarray/pulls/6999
  • [x] Closes #6607
  • [x] Closes #4107
  • [x] Closes #6229
  • [x] Tests added
  • [x] User visible changes (including notable bug fixes) are documented in whats-new.rst

Current implemented "fix": raise a UserWarning and suggest using swap_dims (*)

Alternatively, we could:

  • revert the breaking change (i.e., create the index again) and raise a DeprecationWarning instead
  • raise an error instead of a warning

I don't have strong opinions on this, I'm happy to implement another alternative. The downside of reverting the breaking change now is that unfortunately it will introduce a breaking change in the next release., while workarounds are pretty straightforward.

(*) from https://github.com/pydata/xarray/issues/6607#issuecomment-1126587818, doing ds.set_coords(['lon']).rename(x='lon').set_index(lon='lon') is working too. With #6971, .set_xindex('lon') could work as well.

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/6999/reactions",
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 pull

Links from other tables