|
1 |
| - |
2 | 1 | Language and style
|
3 | 2 | ==================
|
4 | 3 |
|
@@ -174,13 +173,39 @@ Spelling and punctuation
|
174 | 173 | US vs British spelling
|
175 | 174 | ~~~~~~~~~~~~~~~~~~~~~~
|
176 | 175 |
|
177 |
| -We use the US English spelling. |
| 176 | +Use the US English spelling. |
178 | 177 |
|
179 | 178 | Check your spelling and punctuation
|
180 | 179 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
181 | 180 |
|
182 | 181 | Consider checking spelling, grammar, and punctuation with special tools.
|
183 | 182 |
|
| 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 | +
|
184 | 209 | Ending punctuation in lists and tables
|
185 | 210 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
186 | 211 |
|
|
0 commit comments