melange-community / melange-community/jsonkit

Why `json.key` for records but `json.name` for variants?

Open
#43 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
24
Forks
7
Avg merge
1d 15h
Merged PRs (30d)
5

Description

Confused about this choice. There are already quite a lot of PPX attributes, and this case uses different names for different types for the same functionality. Could they both be called json.name?

Or to reduce cognitive impedance even more, use json.as which is very similar to mel.as.

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 by reviewing the existing PPX attributes for records and variants, especially the uses of json.key, json.name, and mel.as mentioned in the issue. Done means reaching agreement on a consistent attribute naming scheme and documenting or implementing the chosen API change.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.