tarantool / tarantool/doc

Documentation is outdated: IPROTO_VERSION is at least 6, not 3

Open
#5,344 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Bug description

Hi Tarantool team,

I'm writing to report inaccuracy in the official documentation regarding the iproto protocol version. I have found in the source code that the documentation needs to be updated.

The documentation for IPROTO_VERSION states that the latest protocol version is 3. https://www.tarantool.io/en/doc/latest/reference/internals/iproto/keys/#iproto-version

However, evidence from both live traffic analysis and the official Python connector's source code indicates that the actual protocol version in use is significantly higher. CONNECTOR_IPROTO_VERSION = 6
https://github.com/tarantool/tarantool-python/blob/master/tarantool/connection.py#L885

Please update the documentation to reflect the current state of the iproto protocol. otherwise, please explain how the above should be interpreted

Thank you for your attention to this matter.

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.

Research direction

Start with the IPROTO_VERSION documentation page linked in the issue and compare its stated version with tarantool-python's connection.py around line 885. Confirm whether the documented value should be updated to 6 or requires an explanation of the version distinction, then update the page and verify the rendered wording.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.