JuliaData / JuliaData/DataAPI.jl

Don't define unwrap(x::Any)

Open
#59 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
35
Forks
13
PR merge metrics
No merged PRs in 30d

Description

If someone has a special need for a function that disregards types, they can make their own wrapper function. The function in DataAPI that's the public function for getting values out of CategoricalValues should only take CategoricalValue. It is too easy to accidentally call unwrap on a type that is not CategoricalValue, such as Vector{CategoricalValue}.

See also https://github.com/JuliaData/CategoricalArrays.jl/issues/399 This change is breaking so should be considered for DataAPI 2.0.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at DataAPI's public unwrap definition and review the linked CategoricalArrays.jl issue for context on the current behavior. Done means unwrap accepts CategoricalValue rather than providing a generic Any method, with the breaking change considered for DataAPI 2.0.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.