Doc improvements #488
Doc improvements #488
Conversation
Current coverage is 81.26% (diff: 100%)@@ master #488 diff @@
==========================================
Files 80 80
Lines 2199 2199
Methods 2090 2090
Messages 0 0
Branches 109 109
==========================================
+ Hits 1786 1787 +1
+ Misses 413 412 -1
Partials 0 0
|
There was a problem hiding this comment.
Thanks again @jonas—I've got a couple of minor comments but this looks good to me.
| @@ -6,7 +6,7 @@ position: 1 | |||
|
|
|||
| # Parsing JSON | |||
|
|
|||
| Circe includes a parsing module, which is a wrapper around the [Jawn][jawn] JSON parser. | |||
| Circe includes a parsing module, which is on the JVM is a wrapper around the [Jawn][jawn] JSON parser and for JavaScript uses the built-in [`JSON.parse`][json.parse]. | |||
There was a problem hiding this comment.
Nitpick: "which is on the JVM is".
| ## Warnings and known issues | ||
|
|
||
| For Scala.js, the result of parsing JSON is restricted to the expressiveness of | ||
| the JavaScript types. In particular numerical values may [loose precision][#393] |
|
|
||
| For Scala.js, the result of parsing JSON is restricted to the expressiveness of | ||
| the JavaScript types. In particular numerical values may [loose precision][#393] | ||
| when decoded by [`JSON.parse`][json.parse] to a JavaScript number. For example: |
There was a problem hiding this comment.
I'm not sure "JavaScript number" is exactly the right phrasing here—it seems more like the problem is that you're trying to decode to a Scala type like Long that has its own semantics, even if it's implemented using JavaScript numbers on Scala.js. I'm happy to work on details like this in a follow-up PR, though.
There was a problem hiding this comment.
OK, I've tried to clarify further. On Scala.js Longs are represented with high/low pair to ensure the Scala semantics and StringLike.toLong and java.lang.long.parseLong works correctly for the issue mentioned in #393. My understanding is that JSON.parse coerces the value into a double at which point circe's JSON AST converter cannot do anything about it.
| @@ -8,3 +8,4 @@ target/ | |||
| .project | |||
| .classpath | |||
| tmp/ | |||
| docs/src/main/tut/contributing.md | |||
There was a problem hiding this comment.
Thanks—I keep meaning to open a PR for this but hadn't yet.
9d5eba9 to
1b473e4
Compare
1b473e4 to
c19331f
Compare
|
👍 |
As discussed on Gitter a few minor tweaks to the Scaladoc and document limitation regarding parsing of numerical values on Scala.js.