iproto: document box.iproto module
#3766
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xuniq
force-pushed
the
gh-3241-iproto
branch
2 times, most recently
from
dc5db4b to
1392de2
Compare
CuriousGeorgiy
requested changes
Oct 30, 2023
xuniq
changed the title
box.iprotomodule
xuniq
changed the title
box.iprotomodulebox.iproto module
CuriousGeorgiy
approved these changes
Nov 9, 2023
xuniq
force-pushed
the
gh-3241-iproto
branch
from
a6a88b5 to
c9cf56d
Compare
andreyaksenov
requested changes
Nov 17, 2023
| * :ref:`flag <reference_lua-box_iproto_flag>` (:ref:`IPROTO_COMMIT <box_protocol-commit>`) | ||
| * :ref:`ballot key <reference_lua-box_iproto_ballot>` (:ref:`IPROTO_FLAG_COMMIT <box_protocol-flags>`) | ||
| * :ref:`metadata key <reference_lua-box_iproto_metadata>` (:ref:`IPROTO_FIELD_IS_NULLABLE <internals-iproto-keys-sql-specific>`) | ||
| * :ref:`RAFT key <reference_lua-box_iproto_raft>` (:ref:`IPROTO_TERM <internals-iproto-keys-term>`) |
There was a problem hiding this comment.
As I see, this page already contains info, examples, and links to IPROTO internals for all namespaces listed in this list. I would think about dropping separate pages for API members (such as box.iproto.key) and moving all these descriptions to the API reference section. But this up to you: I just like the Every page is page one approach to give a user all the context at once :)
In a case you'll decide to merge all this, we can add separate subsections for namespaces, properties, and functions to API reference .
andreyaksenov
approved these changes
Nov 20, 2023
* add functions to Lua and C API * add box.iproto module
xuniq
force-pushed
the
gh-3241-iproto
branch
from
b513b85 to
7d9f4ef
Compare
@CuriousGeorgiy Thank you for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3241
Fixes #3288
Fixes #3278
Staging
box.iproto: https://docs.d.tarantool.io/en/doc/gh-3241-iproto/reference/reference_lua/box_iproto/
C API: https://docs.d.tarantool.io/en/doc/gh-3241-iproto/dev_guide/reference_capi/box/
Added
Lua API:
type,ballot,key,metadata,raft,flag) and features (protocol_features,protocol_version,feature) - each constant type is placed in the correspondingbox.iprotopage.C API:
Binary protocol: