Consider revising the _repr_inline_ protocol
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
_repr_inline_ looks like an IPython special method but is actually includes some xarray specific details: the result should not include shape or dtype.
As I wrote in https://github.com/pydata/xarray/pull/5352, I would suggest revising it in one of two ways:
- Giving it a name like
_xarray_repr_inline_to make it clearer that it's Xarray specific - Include some more generic way of indicating that
shape/dtypeis redundant, e.g,. call it likeobj._repr_ndarray_inline_(dtype=False, shape=False)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing _repr_inline_ protocol and the discussion in pull request #5352, then identify where xarray relies on its current name and behavior. Compare the two proposed designs and trace affected callers and documentation. Done means an agreed protocol design is implemented consistently, with callers and documentation updated and relevant tests passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100