sphinx.rst: Add note about code snippets embedded in the text
authorAndré Almeida <andrealmeid@collabora.com>
Tue, 11 Jun 2019 20:03:16 +0000 (17:03 -0300)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jun 2019 20:43:02 +0000 (14:43 -0600)
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>
Documentation/doc-guide/sphinx.rst

index 4ba081f..e60a566 100644 (file)
@@ -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