Skip to content

Commit ea5c0c7

Browse files
committed
Fix typos & rst syntax
1 parent f17772b commit ea5c0c7

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

doc/reference/reference_lua/key_def.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,10 @@ to extract or compare the index key values.
227227
.. method:: validate_key(key)
228228

229229
Since version :doc:`3.1.0 </release/3.1.0>`
230+
230231
Validates whether the input ``key`` (partially or completely) matches the rules of the key definition object.
231232
Returns nothing on success.
233+
232234
If the key fails the validation, a ``box.error`` type exception is raised.
233235

234236
**Example:**
@@ -248,9 +250,11 @@ to extract or compare the index key values.
248250

249251
.. method:: validate_full_key(key)
250252

251-
Since version :doc:`3.1.0 </release/3.1.0>`
253+
Since version :doc:`3.1.0 </release/3.1.0>`
254+
252255
Validates whether they input ``key`` contains all fields and mathces the rules of the key definition object.
253256
Returns nothing on success.
257+
254258
If the key fails the validation, a ``box.error`` type exception is raised.
255259

256260
**Example:**
@@ -270,9 +274,11 @@ to extract or compare the index key values.
270274

271275
.. method:: validate_tuple(tuple)
272276

273-
Since version :doc:`3.1.0 </release/3.1.0>`
277+
Since version :doc:`3.1.0 </release/3.1.0>`
278+
274279
Validates whether the ``tuple`` matches the rules of the key definition object
275280
Returns nothing on success.
281+
276282
If the key fails the validation, a ``box.error`` type exception is raised.
277283

278284
**Example:**
@@ -293,12 +299,14 @@ to extract or compare the index key values.
293299

294300
.. method:: compare_keys(key_a, key_b)
295301

296-
Since version :doc:`3.1.0 </release/3.1.0>`
302+
Since version :doc:`3.1.0 </release/3.1.0>`
303+
297304
Compares two keys against each other and according to the key definition object.
298305
On success, returns:
299-
* ``<0`` if ``key_a`` parts are less than ``key_b`` parts
300-
* ``0`` if ``key_a`` parts are equal to ``key_b`` parts
301-
* ``>0`` if ``key_a`` parts are greater than ``key_b`` parts
306+
307+
* ``<0`` if ``key_a`` parts are less than ``key_b`` parts
308+
* ``0`` if ``key_a`` parts are equal to ``key_b`` parts
309+
* ``>0`` if ``key_a`` parts are greater than ``key_b`` parts
302310

303311
If any key does not match the key definition rules, a ``box.error`` type exception is raised.
304312

0 commit comments

Comments
 (0)