search

quinnj / JSON3.jl

Other
214 stars 47 forks source link

Getting Started Docs #147

Closed mcmcgrath13 closed 3 years ago

mcmcgrath13 commented 3 years ago

I took my best guess at the docstrings and kwargs based on the code, tests, and past issues & prs. I'm sure there are things that I missed or could use a better explanation. I wasn't sure what to put for why JSON3 vs others, but I think that would be a helpful section (or maybe even just pointers to other JSON-related packages).

closes #146

codecov[bot] commented 3 years ago

Codecov Report

Merging #147 (ea3235a) into main (c73edd7) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #147   +/-   ##
=======================================
  Coverage   88.87%   88.87%           
=======================================
  Files           9        9           
  Lines        1528     1528           
=======================================
  Hits         1358     1358           
  Misses        170      170
Impacted Files Coverage Δ
src/JSON3.jl 100.00% <ø> (ø)
src/gentypes.jl 98.27% <ø> (ø)
src/read.jl 88.08% <ø> (ø)
src/structs.jl 90.31% <ø> (ø)
src/write.jl 74.31% <ø> (ø)
src/pretty.jl 90.90% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c73edd7...ea3235a. Read the comment docs.

mcmcgrath13 commented 3 years ago

@quinnj should pretty(out::IO, x) = pretty(out, JSON3.write(x)) also take the kw... args? (I've included this in the latest commit, probably worth a closer look)