Skip to content

Commit

Permalink
Fix documentation to match implementation
Browse files Browse the repository at this point in the history
Patch: Manuel Pöter & Jens Geyer

This closes #3076
  • Loading branch information
Jens-G committed Dec 13, 2024
1 parent 2c29c56 commit 645467e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/specs/thrift-compact-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ The short form should be used when the length is in the range 0 - 14 (inclusive)

The following element-types are used (see note 1 below):

* `BOOL`, encoded as `1` or '2' (see note 2 below)
* `BOOL`, encoded as `1` or `2` (see note 2 below)
* `I8`, encoded as `3`
* `I16`, encoded as `4`
* `I32`, encoded as `5`
Expand All @@ -266,8 +266,8 @@ The following element-types are used (see note 1 below):
1. Although field-types and element-types lists are currently very similar, there is _no guarantee_ that this will
remain true after new types are added.
2. For historical and compatibility reasons, a reader should be capable to deal with *both* cases.
The only valid value in the original spec was '2', but due to an widespread implementation bug the defacto
standard across large parts of the library became '1' instead. As a result, both values are now allowed.
The only valid value in the original spec was `2`, but due to an widespread implementation bug the defacto
standard across large parts of the library became `1` instead. As a result, both values are now allowed.

The maximum list/set size is configurable. By default there is no limit (meaning the limit is the maximum int32 value:
2147483647).
Expand Down

0 comments on commit 645467e

Please sign in to comment.