Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation to match implementation #3076

Closed
wants to merge 1 commit into from

Conversation

mpoeter
Copy link
Contributor

@mpoeter mpoeter commented Dec 13, 2024

Boolean values are encoded as BOOLEAN_TRUE and BOOLEAN_FALSE which are defined as 1 and 2 instead of 1 and 0.

The element-type of a bool is encoded as BOOLEAN_TRUE so 1 instead of 2.

[skip ci]

Boolean values are encoded as `BOOLEAN_TRUE` and `BOOLEAN_FALSE` which are defined as 1 and 2 instead of 1 and 0.

The element-type of a bool is encoded as `BOOLEAN_TRUE` so 1 instead of 2.
@Jens-G Jens-G added the doc label Dec 13, 2024
@@ -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 below):

* `BOOL`, encoded as `2`
* `BOOL`, encoded as `1`
Copy link
Member

@Jens-G Jens-G Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is debatable. A better word could be inconcistent.

  • erlang and swift do it according to the spec and write 2
  • anyone else writes 1

Hard to say who's wrong here

@Jens-G Jens-G closed this in 2c29c56 Dec 13, 2024
Jens-G added a commit that referenced this pull request Dec 13, 2024
Patch: Manuel Pöter & Jens Geyer

This closes #3076
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants