Commit 83e8b971 authored by André Almeida's avatar André Almeida Committed by Jonathan Corbet

sphinx.rst: Add note about code snippets embedded in the text

There's a paragraph that explains how to create fixed width text block,
but it doesn't explains how to create fixed width text inline, although
this feature is really used through the documentation. Fix that adding a
quick note about it.
Signed-off-by: default avatarAndré Almeida <andrealmeid@collabora.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 407b584d
...@@ -217,7 +217,7 @@ Here are some specific guidelines for the kernel documentation: ...@@ -217,7 +217,7 @@ Here are some specific guidelines for the kernel documentation:
examples, etc.), use ``::`` for anything that doesn't really benefit examples, etc.), use ``::`` for anything that doesn't really benefit
from syntax highlighting, especially short snippets. Use from syntax highlighting, especially short snippets. Use
``.. code-block:: <language>`` for longer code blocks that benefit ``.. code-block:: <language>`` for longer code blocks that benefit
from highlighting. from highlighting. For a short snippet of code embedded in the text, use \`\`.
the C domain the C domain
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment