mcabbott / mcabbott/AxisKeys.jl
`getindex` punning
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 154
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
This package defines a getindex method that conflicts with the getindex documentation:
The relevant doc string implies that getindex(type, args...) should return an AbstractVector{type} with args as its elements.
The context here is that I'm working on a PR to Julia to make eltype more precise for some subtypes of Generator, involving things like Iterators.map(Base.Fix1(getindex, Int), [3, 7]). Thus I'm looking for packages with conflicting assumptions using JuliaHub's code search, to avoid unexpectedly breaking the ecosystem.
Contributor guide
No contributing guide indexed for this repository
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 getindex definition at the linked location in src/selectors.jl and compare its method signature with Julia's Base.getindex documentation. Check how the package's indexing behavior is tested and used; done means the conflicting assumption is resolved without breaking the package's intended indexing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100