Skip to content

Commit 776d57d

Browse files
patiencedaurNickVolynkinTotktonada
authored
Add a guideline for using dashes (#2623)
Co-authored-by: Nick Volynkin <[email protected]> Co-authored-by: Alexander Turenko <[email protected]>
1 parent 8875d37 commit 776d57d

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

doc/contributing/docs/localization/guide.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ We don’t want our audience to feel confused, so we prefer newer terms.
4545
We also provide the English equivalent for a term
4646
if it is used in the article for the first time.
4747

48-
If you feel like the older Russian term may sound more familiar for a part of the audience
48+
If you feel like an older Russian term may sound more familiar for a part of the audience
4949
(for example, those with a math background),
5050
consider adding it in parentheses along with the English equivalent.
5151
Don’t repeat the parentheses throughout the text.
@@ -132,7 +132,7 @@ Prefer verbs over verbal nouns,
132132
and don’t use «являться» and «осуществляться» unless it’s absolutely necessary.
133133

134134
To learn how to clear your Russian texts of bureaucratese,
135-
check `Timur Anikin's training The Writing Dead <https://www.timuroki.ink/thewritingdead>`_.
135+
check `Timur Anikin's training "The Writing Dead" <https://www.timuroki.ink/thewritingdead>`_.
136136

137137
.. container:: table
138138

@@ -145,7 +145,7 @@ check `Timur Anikin's training The Writing Dead <https://www.timuroki.ink/thewri
145145
* - Сообщение исчезнет, как только вы покинете данную страницу.
146146
- Сообщение исчезнет, как только вы покинете страницу.
147147
* - Проверка истечения срока действия паролей производится раз в 30 минут.
148-
- Система раз в 30 минут проверяет, не истек ли срок действия паролей.
148+
- Раз в 30 минут система проверяет, не истек ли срок действия паролей.
149149

150150
Consistency
151151
~~~~~~~~~~~

doc/contributing/docs/style.rst

+27-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Language and style
32
==================
43

@@ -174,13 +173,39 @@ Spelling and punctuation
174173
US vs British spelling
175174
~~~~~~~~~~~~~~~~~~~~~~
176175

177-
We use the US English spelling.
176+
Use the US English spelling.
178177

179178
Check your spelling and punctuation
180179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181180

182181
Consider checking spelling, grammar, and punctuation with special tools.
183182

183+
Dashes
184+
~~~~~~
185+
186+
Special symbols like dashes, quotation marks, and apostrophes look the same
187+
across all Tarantool documentation in a single language.
188+
This is because the documentation :doc:`builder </contributing/docs/build/>`
189+
renders specific character sequences in the source into correct typographic characters.
190+
191+
Type three hyphens (``---``) to insert an em dash (---)
192+
and two hyphens (``--``) for an en dash (--).
193+
The following rules apply:
194+
195+
* The longer **em dash** ``---`` is used to separate extra information or mark a break in a sentence.
196+
* The shorter **en dash** ``--`` is used to mark ranges (for example, 4--16 GB or Dover--Calais crossing).
197+
198+
Don't use a single hyphen as a dash. Don't add spaces on either side of a dash.
199+
200+
When indicating a range like ``code element 1``\--``code element 2``, escape the series of hyphens using
201+
`character-level inline markup <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#character-level-inline-markup-1>`_.
202+
Otherwise, the RST interpreter will perceive the dash as part of the RST syntax:
203+
204+
.. code-block:: rst
205+
206+
``box.begin()``\--``box.commit()``
207+
208+
184209
Ending punctuation in lists and tables
185210
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
186211

0 commit comments

Comments
 (0)