Skip to content

Commit d9fca5d

Browse files
committed
Apply suggestions from technical writer's review
1 parent 3f072c5 commit d9fca5d

File tree

8 files changed

+53
-17
lines changed

8 files changed

+53
-17
lines changed

doc/dev_guide/internals/iproto/events.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ Sent by the server to notify a client about an update of a key.
6868
:file: images/event.svg
6969

7070
``IPROTO_EVENT_DATA`` contains data sent to a remote watcher.
71-
The parameter is optional, the default value is ``nil``.
71+
The parameter is optional, the default value is ``MP_NIL``.

doc/dev_guide/internals/iproto/format.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Request and response format
44
===========================
55

66
The types referred to in this document are `MessagePack <http://MessagePack.org>`_ types.
7-
For type definitions, see the :ref:`Symbols and terms <box_protocol-notation>` section.
7+
For their definitions, see the :ref:`MP_* MessagePack types <box_protocol-notation>` section.
88

99
.. _internals-unified_packet_structure:
1010

@@ -22,7 +22,7 @@ Size
2222
----
2323

2424
The size is an MP_UINT -- unsigned integer, usually 32-bit.
25-
It it the size of the header plus the size of the body.
25+
It the size of the header plus the size of the body.
2626
It may be useful to compare it with the number of bytes remaining in the packet.
2727

2828
.. _box_protocol-header:
@@ -65,7 +65,7 @@ the IPROTO_REQUEST_TYPE value will be 0 = ``IPROTO_OK`` and the
6565
array will have all the tuples of the result.
6666

6767
Read the source code file `net_box.c <https://github.com/tarantool/tarantool/blob/master/src/box/lua/net_box.c>`__
68-
where the function "decode_metadata_optional" is an example of how Tarantool
68+
where the function ``decode_metadata_optional`` is an example of how Tarantool
6969
itself decodes extra items.
7070

7171
Body

doc/dev_guide/internals/iproto/images/sql_response_other.puml

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ json "**Response to SQL requests other than SELECT, VALUES, or PRAGMA**" as sql_
1616
},
1717
"Body": {
1818
"[[tarantool.io/en/doc/latest/dev_guide/internals/iproto/keys SQL_INFO]]": {
19-
"[[tarantool.io/en/doc/latest/dev_guide/internals/iproto/keys SQL_INFO_ROW_COUNT]]": "MP_UINT"
19+
"[[tarantool.io/en/doc/latest/dev_guide/internals/iproto/keys SQL_INFO_ROW_COUNT]]": "MP_UINT",
20+
"(Optional) [[tarantool.io/en/doc/latest/dev_guide/internals/iproto/keys SQL_INFO_AUTO_INCREMENT_IDS]]": "MP_ARRAY"
2021
}
2122
}
2223
}

doc/dev_guide/internals/iproto/images/sql_response_other.svg

+3-2
Loading

doc/dev_guide/internals/iproto/keys.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ General
4040

4141
* - :ref:`IPROTO_SCHEMA_VERSION <internals-iproto-keys-schema_version>`
4242
- 0x05 |br| MP_UINT
43-
- Identifier that is increased with every major change
43+
- Version of the database schema
4444

4545
* - IPROTO_TIMESTAMP
4646
- 0x04 |br| MP_DOUBLE
@@ -109,7 +109,7 @@ General
109109

110110
* - IPROTO_EXPR
111111
- 0x27 |br| MP_STR
112-
- Command argument. Passed within :ref:`IPROTO_EVAL <box_protocol-eval>`
112+
- Command argument. Used in :ref:`IPROTO_EVAL <box_protocol-eval>`
113113

114114

115115
Streams
@@ -455,7 +455,8 @@ IPROTO_SCHEMA_VERSION
455455

456456
Code: 0x05.
457457

458-
An unsigned number that goes up when there is a major change in the schema.
458+
Version of the database schema --
459+
an unsigned number that goes up when there is a major change in the schema.
459460

460461
In a *request* header, IPROTO_SCHEMA_VERSION is optional, so the version will not
461462
be checked if it is absent.

doc/dev_guide/internals/iproto/mp_types.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@
33
MP_* MessagePack types
44
======================
55

6-
The binary protocol handles data in the MessagePack format, which makes use of MessagePack data types.
6+
The binary protocol handles data in the `MessagePack <http://MessagePack.org>`_ format.
7+
Short descriptions of the basic MessagePack data types
8+
are on MessagePack's `"spec" page <https://github.com/msgpack/msgpack/blob/master/spec.md>`_.
9+
Tarantool also introduces several MessagePack type :ref:`extensions <internals-msgpack_ext>`.
10+
11+
In this document, MessagePack types are described by words that start with **MP_**.
12+
See this table:
713

8-
This document makes use of words that start with **MP_**. They mean
9-
a `MessagePack <http://MessagePack.org>`_ type or a range of MessagePack types,
10-
including the signal and possibly including a value, with slight modification:
1114

1215
.. container:: table
1316

@@ -39,5 +42,3 @@ including the signal and possibly including a value, with slight modification:
3942
- :ref:`extension <internals-msgpack_ext>`
4043
* - **MP_OBJECT**
4144
- any MessagePack object
42-
43-
Short descriptions are in MessagePack's `"spec" page <https://github.com/msgpack/msgpack/blob/master/spec.md>`_.

doc/dev_guide/internals/iproto/sql.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Basic request description
2626

2727
* - :ref:`IPROTO_PREPARE <box_protocol-prepare>`
2828
- 0x0d
29-
- Prepare an SQL statement (:ref:`box.prepare <box-sql_box_prepare>`)
29+
- Prepare an SQL statement (:ref:`box.prepare() <box-sql_box_prepare>`)
3030

3131

3232
.. _box_protocol-execute:

0 commit comments

Comments
 (0)