Zen

Translation

English
for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
128/1280 · 128
English Russian Actions
Even worse: "shellcheck your Bash code". There's no such word in English and we don't explain what to use.
 
Cursed: "try ``shellchecking`` your Bash code". There's no such word and no such application.
 
Code blocks and inline code
 
If you have to choose between inline code and code block highlighting, pay attention to the following guidelines:
 
Code snippets
 
Use code blocks when you have to highlight multiple lines of code. Also, use it if your code snippet contains a standalone element that is not a part of the article's text.
 
For code snippets, we use the ``code-block:: language`` `directive <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block>`_. You can enable syntax highlighting if you specify the language for the snippet. The most commonly used highlighting languages are:
 
``tarantoolsession``—interactive Tarantool session, where command lines start with ``tarantool>`` prompt.
 
``console``—interactive console session, where command lines start with ``$`` or ``#``.
 
``lua``, ``bash`` or ``c`` for programming languages.
 
``text`` for cases when we want the code block to have no highlighting.
 
Sphinx uses the Pygments library for highlighting source code. For a complete list of possible languages, see the `list of Pygments lexers <https://pygments.org/docs/lexers/>`_.
 
For example, a code snippet in Lua:
 
.. code-block:: lua

for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
 
Lua syntax is highlighted in the output:
 
for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
Note that in code blocks you can write comments and translate them:
 
.. //Here is the first comment.
.. //Here is the second comment.
 
Inline code
 
Use inline code when you need to wrap a short snippet of code in text, such as variable name or function definition. Keep in mind that inline code doesn't have syntax highlighting.
 
To format some inline text as ``code``, enclose it with double ````` characters or use the ``:code:`` role:
 
* Formatting code with backticks: ``echo "Hello world!"``.

* Formatting code with a role: :code:`echo "Hello world!"`.
 
Both options produce the same output:
 
Formatting code with backticks: ``echo "Hello world!"``.
 
Formatting code with a role: :code:`echo "Hello world!"`.
 
Notes on using inline-code
 
If you have expressions such as ``id==4``, you should format the whole expression as code inline. Also, you can use the words "equals", "doesn't equal" or other similar words without formatting expression as code. Both variants are correct.
 
Inline code can be used to highlight expressions that are hard to read, for example, words containing ``il``, ``Il`` or ``O0``.
 
Highlighting variables in code
 
If you need to mark up a placeholder inside code inline, use the ``:samp:`` or our custom ``:extsamp:`` role, like this:
 
:samp:`{space_object}:insert(\\{ffi.cast('double', {value})\\})`

:extsamp:`{*{space_object}*}:insert({ffi.cast('double', {**{value}**})})`
 

Loading…

User avatar None

String updated in the repository

testing_project / Documentation: contributing/docs/markup/code — Russian

for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
for page in paged_iter("X", 10) do
print("New Page. Number Of Tuples = " .. #page)
for i=1,#page,1 do print(page[i]) end
end
a year ago
Browse all string changes

Things to check

Unchanged translation

Source and translation are identical

Reset

Glossary

English Russian
No related strings found in the glossary.

String information

String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
locale/ru/LC_MESSAGES/contributing/docs/markup/code.po, string 32