Skip to content

Commit

Permalink
sphinx.rst: Add note about code snippets embedded in the text
Browse files Browse the repository at this point in the history
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: André Almeida <andrealmeid@collabora.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
andrealmeid authored and Jonathan Corbet committed Jun 14, 2019
1 parent 407b584 commit 83e8b97
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/doc-guide/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Here are some specific guidelines for the kernel documentation:
examples, etc.), use ``::`` for anything that doesn't really benefit
from syntax highlighting, especially short snippets. Use
``.. 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
Expand Down

0 comments on commit 83e8b97

Please sign in to comment.