Skip to content

Commit 3612f3f

Browse files
patiencedaurpatiencedaur
authored
Fix small operational issues (#2843)
* Add a missing comma in release table * Replace 'hash' index with 'tree' in the tutorial * Add a link to index types doc Resolves #2351 * Add a guideline for referring to GUI elements Resolves #2823
1 parent ff44836 commit 3612f3f

File tree

7 files changed

+52
-37
lines changed

7 files changed

+52
-37
lines changed

‎doc/contributing/docs/markup.rst

+1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ This section will guide you through our typical documentation formatting cases.
1717
markup/links
1818
markup/tables
1919
markup/code
20+
markup/gui
2021
markup/admonitions

‎doc/contributing/docs/markup/gui.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Referring to GUI elements
2+
=========================
3+
4+
To mention a GUI element, use the ``:guilabel:`` directive:
5+
6+
.. code-block:: rst
7+
8+
Click the :guilabel:`OK` button.

‎doc/getting_started/using_docker.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,12 @@ Create the first :ref:`index <index-box_index>` (named ``primary``):
124124
.. code-block:: tarantoolsession
125125
126126
tarantool.sock> s:create_index('primary', {
127-
> type = 'hash',
127+
> type = 'tree',
128128
> parts = {'id'}
129129
> })
130130
131131
This is a primary index based on the ``id`` field of each tuple.
132+
``TREE`` is the most universal index type. To learn more, check the documentation on Tarantool :ref:`index types <index-types>`.
132133

133134
Insert three :term:`tuples <tuple>` (our name for records)
134135
into the space:
@@ -160,7 +161,7 @@ The terminal screen now looks like this:
160161
---
161162
...
162163
tarantool.sock> s:create_index('primary', {
163-
> type = 'hash',
164+
> type = 'tree',
164165
> parts = {'id'}
165166
> })
166167
---
@@ -172,7 +173,7 @@ The terminal screen now looks like this:
172173
id: 0
173174
space_id: 512
174175
name: primary
175-
type: HASH
176+
type: TREE
176177
...
177178
tarantool.sock> s:insert{1, 'Roxette', 1986}
178179
---
@@ -196,7 +197,7 @@ To add a secondary index based on the ``band_name`` field, run:
196197
.. code-block:: tarantoolsession
197198
198199
tarantool.sock> s:create_index('secondary', {
199-
> type = 'hash',
200+
> type = 'tree',
200201
> parts = {'band_name'}
201202
> })
202203

‎doc/getting_started/using_package_manager.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,12 @@ Here is how to create a simple test database after installation.
114114
.. code-block:: tarantoolsession
115115
116116
tarantool> s:create_index('primary', {
117-
> type = 'hash',
117+
> type = 'tree',
118118
> parts = {'id'}
119119
> })
120120
121121
This is a primary index based on the ``id`` field of each tuple.
122+
``TREE`` is the most universal index type. To learn more, check the documentation on Tarantool :ref:`index types <index-types>`.
122123

123124
#. Insert three :term:`tuples <tuple>` (our name for records)
124125
into the space:
@@ -150,7 +151,7 @@ Here is how to create a simple test database after installation.
150151
---
151152
...
152153
tarantool> s:create_index('primary', {
153-
> type = 'hash',
154+
> type = 'tree',
154155
> parts = {'id'}
155156
> })
156157
---
@@ -162,7 +163,7 @@ Here is how to create a simple test database after installation.
162163
id: 0
163164
space_id: 512
164165
name: primary
165-
type: HASH
166+
type: TREE
166167
...
167168
tarantool> s:insert{1, 'Roxette', 1986}
168169
---
@@ -186,7 +187,7 @@ Here is how to create a simple test database after installation.
186187
.. code-block:: tarantoolsession
187188
188189
tarantool> s:create_index('secondary', {
189-
> type = 'hash',
190+
> type = 'tree',
190191
> parts = {'band_name'}
191192
> })
192193

‎doc/release/notes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ based on the :doc:`new release policy <policy>`:
2727

2828
* - 2.10
2929
- n/a
30-
- :doc:`2.10.0-beta1 <2.10.0-beta1>`
30+
- :doc:`2.10.0-beta1 <2.10.0-beta1>`,
3131
`2.10.0-beta2 <https://github.com/tarantool/tarantool/releases/tag/2.10.0-beta2>`_
3232
- :doc:`2.10.0-rc1 <2.10.0-rc1>`
3333
- not released yet

‎locale/ru/LC_MESSAGES/getting_started/getting_started_db.po

+20-18
Original file line numberDiff line numberDiff line change
@@ -184,17 +184,19 @@ msgstr ""
184184

185185
msgid ""
186186
"tarantool.sock> s:create_index('primary', {\n"
187-
" > type = 'hash',\n"
187+
" > type = 'tree',\n"
188188
" > parts = {'id'}\n"
189189
" > })"
190190
msgstr ""
191191
"tarantool.sock> s:create_index('primary', {\n"
192-
" > type = 'hash',\n"
192+
" > type = 'tree',\n"
193193
" > parts = {'id'}\n"
194194
" > })"
195195

196-
msgid "This is a primary index based on the ``id`` field of each tuple."
197-
msgstr "Это первичный индекс по полю ``id`` в каждом кортеже."
196+
msgid "This is a primary index based on the ``id`` field of each tuple. "
197+
"``TREE`` is the most universal index type. To learn more, check the documentation on Tarantool :ref:`index types <index-types>`."
198+
msgstr "Это первичный индекс по полю ``id`` в каждом кортеже. "
199+
"Тип индекса ``TREE`` --- самый универсальный. Подробная информация изложена в документации о :ref:`типах индексов в Tarantool <index-types>`."
198200

199201
msgid ""
200202
"Insert three :term:`tuples <tuple>` (our name for records) into the space:"
@@ -232,7 +234,7 @@ msgid ""
232234
"---\n"
233235
"...\n"
234236
"tarantool.sock> s:create_index('primary', {\n"
235-
" > type = 'hash',\n"
237+
" > type = 'tree',\n"
236238
" > parts = {'id'}\n"
237239
" > })\n"
238240
"---\n"
@@ -244,7 +246,7 @@ msgid ""
244246
" id: 0\n"
245247
" space_id: 512\n"
246248
" name: primary\n"
247-
" type: HASH\n"
249+
" type: TREE\n"
248250
"...\n"
249251
"tarantool.sock> s:insert{1, 'Roxette', 1986}\n"
250252
"---\n"
@@ -274,7 +276,7 @@ msgstr ""
274276
"---\n"
275277
"...\n"
276278
"tarantool.sock> s:create_index('primary', {\n"
277-
" > type = 'hash',\n"
279+
" > type = 'tree',\n"
278280
" > parts = {'id'}\n"
279281
" > })\n"
280282
"---\n"
@@ -286,7 +288,7 @@ msgstr ""
286288
" id: 0\n"
287289
" space_id: 512\n"
288290
" name: primary\n"
289-
" type: HASH\n"
291+
" type: TREE\n"
290292
"...\n"
291293
"tarantool.sock> s:insert{1, 'Roxette', 1986}\n"
292294
"---\n"
@@ -310,12 +312,12 @@ msgstr ""
310312

311313
msgid ""
312314
"tarantool.sock> s:create_index('secondary', {\n"
313-
" > type = 'hash',\n"
315+
" > type = 'tree',\n"
314316
" > parts = {'band_name'}\n"
315317
" > })"
316318
msgstr ""
317319
"tarantool.sock> s:create_index('secondary', {\n"
318-
" > type = 'hash',\n"
320+
" > type = 'tree',\n"
319321
" > parts = {'band_name'}\n"
320322
" > })"
321323

@@ -510,12 +512,12 @@ msgstr ""
510512

511513
msgid ""
512514
"tarantool> s:create_index('primary', {\n"
513-
" > type = 'hash',\n"
515+
" > type = 'tree',\n"
514516
" > parts = {'id'}\n"
515517
" > })"
516518
msgstr ""
517519
"tarantool> s:create_index('primary', {\n"
518-
" > type = 'hash',\n"
520+
" > type = 'tree',\n"
519521
" > parts = {'id'}\n"
520522
" > })"
521523

@@ -543,7 +545,7 @@ msgid ""
543545
"---\n"
544546
"...\n"
545547
"tarantool> s:create_index('primary', {\n"
546-
" > type = 'hash',\n"
548+
" > type = 'tree',\n"
547549
" > parts = {'id'}\n"
548550
" > })\n"
549551
"---\n"
@@ -555,7 +557,7 @@ msgid ""
555557
" id: 0\n"
556558
" space_id: 512\n"
557559
" name: primary\n"
558-
" type: HASH\n"
560+
" type: TREE\n"
559561
"...\n"
560562
"tarantool> s:insert{1, 'Roxette', 1986}\n"
561563
"---\n"
@@ -585,7 +587,7 @@ msgstr ""
585587
"---\n"
586588
"...\n"
587589
"tarantool> s:create_index('primary', {\n"
588-
" > type = 'hash',\n"
590+
" > type = 'tree',\n"
589591
" > parts = {'id'}\n"
590592
" > })\n"
591593
"---\n"
@@ -597,7 +599,7 @@ msgstr ""
597599
" id: 0\n"
598600
" space_id: 512\n"
599601
" name: primary\n"
600-
" type: HASH\n"
602+
" type: TREE\n"
601603
"...\n"
602604
"tarantool> s:insert{1, 'Roxette', 1986}\n"
603605
"---\n"
@@ -618,12 +620,12 @@ msgstr ""
618620

619621
msgid ""
620622
"tarantool> s:create_index('secondary', {\n"
621-
" > type = 'hash',\n"
623+
" > type = 'tree',\n"
622624
" > parts = {'band_name'}\n"
623625
" > })"
624626
msgstr ""
625627
"tarantool> s:create_index('secondary', {\n"
626-
" > type = 'hash',\n"
628+
" > type = 'tree',\n"
627629
" > parts = {'band_name'}\n"
628630
" > })"
629631

‎locale/ru/LC_MESSAGES/getting_started/using_docker.po

+12-10
Original file line numberDiff line numberDiff line change
@@ -190,17 +190,19 @@ msgstr ""
190190

191191
msgid ""
192192
"tarantool.sock> s:create_index('primary', {\n"
193-
" > type = 'hash',\n"
193+
" > type = 'tree',\n"
194194
" > parts = {'id'}\n"
195195
" > })"
196196
msgstr ""
197197
"tarantool.sock> s:create_index('primary', {\n"
198-
" > type = 'hash',\n"
198+
" > type = 'tree',\n"
199199
" > parts = {'id'}\n"
200200
" > })"
201201

202-
msgid "This is a primary index based on the ``id`` field of each tuple."
203-
msgstr "Это первичный индекс по полю ``id`` в каждом кортеже."
202+
msgid "This is a primary index based on the ``id`` field of each tuple. "
203+
"``TREE`` is the most universal index type. To learn more, check the documentation on Tarantool :ref:`index types <index-types>`."
204+
msgstr "Это первичный индекс по полю ``id`` в каждом кортеже. "
205+
"Тип индекса ``TREE`` --- самый универсальный. Подробная информация изложена в документации о :ref:`типах индексов в Tarantool <index-types>`."
204206

205207
msgid ""
206208
"Insert three :ref:`tuples <index-box_tuple>` (our name for records) into the"
@@ -240,7 +242,7 @@ msgid ""
240242
"---\n"
241243
"...\n"
242244
"tarantool.sock> s:create_index('primary', {\n"
243-
" > type = 'hash',\n"
245+
" > type = 'tree',\n"
244246
" > parts = {'id'}\n"
245247
" > })\n"
246248
"---\n"
@@ -252,7 +254,7 @@ msgid ""
252254
" id: 0\n"
253255
" space_id: 512\n"
254256
" name: primary\n"
255-
" type: HASH\n"
257+
" type: TREE\n"
256258
"...\n"
257259
"tarantool.sock> s:insert{1, 'Roxette', 1986}\n"
258260
"---\n"
@@ -282,7 +284,7 @@ msgstr ""
282284
"---\n"
283285
"...\n"
284286
"tarantool.sock> s:create_index('primary', {\n"
285-
" > type = 'hash',\n"
287+
" > type = 'tree',\n"
286288
" > parts = {'id'}\n"
287289
" > })\n"
288290
"---\n"
@@ -294,7 +296,7 @@ msgstr ""
294296
" id: 0\n"
295297
" space_id: 512\n"
296298
" name: primary\n"
297-
" type: HASH\n"
299+
" type: TREE\n"
298300
"...\n"
299301
"tarantool.sock> s:insert{1, 'Roxette', 1986}\n"
300302
"---\n"
@@ -320,12 +322,12 @@ msgstr ""
320322

321323
msgid ""
322324
"tarantool.sock> s:create_index('secondary', {\n"
323-
" > type = 'hash',\n"
325+
" > type = 'tree',\n"
324326
" > parts = {'band_name'}\n"
325327
" > })"
326328
msgstr ""
327329
"tarantool.sock> s:create_index('secondary', {\n"
328-
" > type = 'hash',\n"
330+
" > type = 'tree',\n"
329331
" > parts = {'band_name'}\n"
330332
" > })"
331333

0 commit comments

Comments
 (0)