JuliaCollections / JuliaCollections/DataStructures.jl

[Tracking] MultiDict and SortedMultiDict API updates before v1.0

Open
#666 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
745
Forks
261
PR merge metrics
No merged PRs in 30d

Description

I wanted to create this meta-issue to track all the API changes that we want to do for MultiDict, which are currently scattered around various other threads:

And to use this thread to discuss other changes we might make.


Current suggested changes:

  • Make MultiDict API consistently operate over pairs, just like a normal Dict, except that multiple entries are allowed per key.
    • WIP fix in #676
  • Use a Set{T} instead of Vector{T} for the multi-values ([?] -- see discussion below)
    • WIP fix in #692

Open Questions:

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 with the linked issues and pull requests, especially #654, #655, #656, #676, and #692, then read the exposition in #522. The checklist and open questions define the scope, but several items are still under discussion or have work in progress. Done would require resolving the agreed MultiDict and SortedMultiDict API changes and updating the related work accordingly.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.