Document missing IPROTO constants
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/
SME: @
Details
Some IPROTO constants are missing in the docs:
-
Group_id (IPROTO_GROUP_ID)
https://github.com/tarantool/doc/issues/568
https://github.com/tarantool/tarantool/commit/f64f46199e19542fa60eede939d62cd115abb83a -
IPROTO_DATA (described в box_protocol-body)
-
Old_tuple https://github.com/tarantool/tarantool/commit/03e249b934e483e6c2c71692753f09ce6ee95918
-
New_tuple
https://github.com/tarantool/tarantool/commit/03e249b934e483e6c2c71692753f09ce6ee95918 -
Tuple_meta
https://github.com/tarantool/tarantool/commit/e4cc14f942d4b1f2e3e685cb617aacbf2c38b962 -
IPROTO_FEATURE_PAGINATION
-
JOIN_META - covered by #2276
-
JOIN_SNAPSHOT - covered by #2276
Don't forget to update the links to iproto constants in the box.iproto submodule.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the box_protocol root document and its box_protocol-body section, then review the linked Tarantool commits and the box.iproto submodule references. Document the listed missing IPROTO constants, omit JOIN_META and JOIN_SNAPSHOT already covered by #2276, and update the links to the constants.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100