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

From: "André Almeida" <andrealmeid@collabora.com>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, corbet@lwn.net,
	kernel@collabora.com, "André Almeida" <andrealmeid@collabora.com>
Subject: [PATCH] sphinx.rst: Add note about code snippets embedded in the text
Date: Tue, 11 Jun 2019 17:03:16 -0300	[thread overview]
Message-ID: <20190611200316.30054-1-andrealmeid@collabora.com> (raw)

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>
---
 Documentation/doc-guide/sphinx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index c039224b404e..f48abc07f4c5 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -218,7 +218,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
-- 
2.22.0

