json4s / json4s/json4s

#suggestion/#request: snippet in README.md for flatten function from Extract

Open
#457 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Scala
Stars
1.5k
Forks
324
Avg merge
4h 35m
Merged PRs (30d)
30

Description

json4s version

latest

scala version

11.7

jdk version

0.8

Hi there, would it be possible to include a little snippet on Extract.flatten on the project page? Or the Extract package as a whole. I ended-up writing my own flatterer to find out later, through the following link

https://searchcode.com/codesearch/view/69075744/

that json4s had already a tail-recursive flattening function... -_-*

I can compare the results now with your version.

I'm mentioning that for the benefit of the community as a whole. A lot of people in parsing and processing data benefit from flat Json.

Anyway, food for thought. Love you guys project, Alex

Contributor guide

Open the contributing guide

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

The request names README.md and Extract.flatten; start by reviewing the existing Extract API and the linked flattening example. Add a small README usage snippet for Extract.flatten, or the Extract package more broadly, so users can discover how to work with flat JSON.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.