JuliaData / JuliaData/DataAPI.jl
Change describe contract
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 35
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Currently describe contract is that it does pretty print the passed object.
The contract does not say what the function returns. I propose that describe should keep to print what it promises, but also return the computed statistics.
The crucial problem is that in REPL this would "double print" the contents. Also there is a duplication between describe and summarystats.
I am not sure what is best, but I leave this issue open to keep track of it.
CC @nalimilan
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 comparing the describe and summarystats entry points and how describe behaves in the REPL. Resolve whether describe should return computed statistics while preserving its printing contract, and define the expected REPL behavior so completion can be verified without double printing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100