Skip to content

Commit fb6056a

Browse files
authored
Clarify nil data type status
Resolves #2765
1 parent c78d2df commit fb6056a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/book/box/data_model.rst

+12-12
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ Lua versus MsgPack
136136
- Example value
137137
* - scalar
138138
- nil
139-
- `nil`_
140-
- ``nil``
139+
- `cdata`_
140+
- :ref:`box.NULL <box-null>`
141141
* - scalar
142142
- boolean
143143
- `boolean`_
@@ -182,10 +182,6 @@ Lua versus MsgPack
182182
- ext (for Tarantool ``uuid``)
183183
- `cdata`_
184184
- ``12a34b5c-de67-8f90-123g-h4567ab8901``
185-
* - scalar
186-
- msgpack.NULL
187-
- `cdata`_
188-
- :ref:`box.NULL <box-null>`
189185
* - compound
190186
- map
191187
- `table`_ (with string keys)
@@ -199,18 +195,22 @@ Lua versus MsgPack
199195
- tuple (`cdata`_)
200196
- ``[12345, 'A B C']``
201197

198+
.. _boolean: http://www.lua.org/pil/2.2.html
199+
.. _string: http://www.lua.org/pil/2.4.html
200+
.. _number: http://www.lua.org/pil/2.3.html
201+
.. _table: http://www.lua.org/pil/2.5.html
202+
.. _cdata: http://luajit.org/ext_ffi.html#call
203+
202204
.. note::
203205

204206
MsgPack values have variable lengths.
205207
So, for example, the smallest number requires only one byte, but the largest number
206208
requires nine bytes.
207209

208-
.. _nil: http://www.lua.org/pil/2.1.html
209-
.. _boolean: http://www.lua.org/pil/2.2.html
210-
.. _string: http://www.lua.org/pil/2.4.html
211-
.. _number: http://www.lua.org/pil/2.3.html
212-
.. _table: http://www.lua.org/pil/2.5.html
213-
.. _cdata: http://luajit.org/ext_ffi.html#call
210+
.. note::
211+
212+
The Lua `nil <http://www.lua.org/pil/2.1.html>`_ type is encoded as MsgPack ``nil`` but
213+
decoded as :ref:`msgpack.NULL <box-null>`.
214214

215215
.. _index_box_field_type_details:
216216

0 commit comments

Comments
 (0)