Inconsistency regarding message types/IDs

Open Beginner friendly
  • Is something wrong?
#353 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
documentation

Research direction

Read the binary message ID structure section linked in the issue and compare its terminology with the quoted passages. Find the specification source for that section, then make the terms consistent with the intended distinction between a message type and an individual message ID. Done when the specification uses consistent terminology throughout.

Written by the indexing model from the issue text.

Description

Binary message types are sometimes, most importantly in the section that lists them, called message IDs, which I personally think is the worse term. Message ID makes me think that one specific message is being identified, and not a whole class (type) of messages.

Examples

The first byte of every decrypted binary message is its message ID.

Each complete binary message carries exactly one Noise transport message; after AEAD decryption, the first byte is a uint8 representing the message type.

Each visualization type has its own binary message type.

Dominant language
Python
Stars
135
Forks
11
Avg merge
2d 14h
Merged PRs (30d)
38

Getting set up

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 Sendspin/spec

All issues in Sendspin/spec

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.