Documentation for implementation limits and related design choices

Open
#744 0 comments 0 reactions 1 assignee View on GitHub

@grisumbras is already working on this.

Since Jun 1, 2023.

Assessment

This issue has not been assessed yet.

Description

Doc

Documentation would benefit from the
info on implementation-limits-related design choices.

  • Guaranteed roundtrip for value -> serialized text -> value (but note that infinity and NaN can be in the original value and do not currently serialize properly).
  • JSON inputs where number values cannot be represented losslessly in
    uint64_t, int64_t and double, may render different values when parsed and
    then serialized back, and for extremely big number values can even fail to
    parse (document supported number ranges).
  • Whatever JSON output you can produce with this library, we guarantee it
    can be passed by any common JSON implementation (probably also based on
    uint64_t + int64_t + double implementation) (this hardly can be anything specific, we can only present it as a goal of the library).

Also

  • Configuration macros that affect implementation limits
  • Hard-coded/default implementation limits
Dominant language
C++
Stars
478
Forks
110
Avg merge
8d 12h
Merged PRs (30d)
6

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.

More from boostorg/json

All issues in boostorg/json

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.