mcabbott / mcabbott/AxisKeys.jl
Document `setkey!` in the README
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 154
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
I love being able to do this but always have to dig a bit to remember how it's called. Possibly on purpose, as it is not exported? Would it be helpful to have it in the docs with a warning?
Not sure what kind of black magic would be needed, but getting a custom error message when trying
julia> ka = AxisKeys.wrapdims(rand(3); obs=1:3);
julia> ka(obs=1) = 1.0
ERROR: cannot define function ka; it already has a value
Stacktrace:
[1] top-level scope
@ none:0
[2] top-level scope
@ REPL[89]:1
could be helpful for people starting out as well.
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 in the README and verify the existing Julia usage of setkey!, including whether its non-exported status needs explanation. Done means the README documents how to call it and includes an appropriate warning; the proposed custom error message should be clarified or treated as separate scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100