docs: add note clarifying multipleOf implementation #1206
Conversation
add a note explaining the difference between float-point implementation of programming languages and json schema
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1206 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 373
Branches 94 94
=========================================
Hits 373 373 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Thanks for giving this a start. There are a few things that need a second draft.
The JSON Specification allows an arbitrary implementation of the
multipleOfkeyword
The JSON Schema Specification defines multipleOf, not the JSON Specification. There is nothing arbitrary about multipleOf. It has a precise definition and consistent behavior across implementations. I'm not sure what this statement is trying to communicate to the reader, but it's full of inaccuracies.
and is not constrained by the floating-point behavior of most programming languages.
This part is correct.
In contrast, most programming languages adhere to the IEEE754 standard for floating-point numbers, which can result in discrepancies between validation according to the JSON Specification and the behavior in programming languages.
This is correct, but not the way I would frame it. I would say that with JSON Schema you don't need to worry about the limitations of IEEE754 floating-point numbers like you do in most programming languages.
|
Thanks a lot for the review @jdesrosiers Thank you specifying exact changes needed, I'll be fixing these and would push the changes as soon as possible. |
| @@ -162,6 +162,7 @@ The multiple can be a floating point number: | |||
| 4.021 | |||
| ``` | |||
|
|
|||
| <Infobox label="Note"> The JSON Schema Specification defines numerical precision independently of the IEEE 754 standard. This means developers do not need to worry about the typical limitations of floating-point arithmetic, such as precision loss or representation errors, which are common in most programming languages. </Infobox> | |||
There was a problem hiding this comment.
You still have this a little confused. The JSON specification defines numbers. The JSON Schema specification defines multipleOf using JSON numbers.
What kind of change does this PR introduce?
Documentation update
Issue Number:
multipleOf#1113Screenshots/videos:
Summary
Add a note explaining the difference between float-point implementation of programming languages and json schema
Does this PR introduce a breaking change?
No, it does not.
Other
I believe this note can be clearer, better if I also provide an example, not sure about it though. Please let me know about it.