Re: [RFC] doc: fix code snippet build warnings

From: Jani Nikula
Date: Tue Jan 16 2018 - 05:21:44 EST


On Thu, 11 Jan 2018, "Tobin C. Harding" <me@xxxxxxxx> wrote:
> On Wed, Jan 10, 2018 at 02:59:58PM -0700, Jonathan Corbet wrote:
>> ...rather than adding a separate "::" line, you can just
>> s/follows:/follows::/ and the Right Thing will happen (to the same extent
>> that it does now, anyway.
>
> Except that it will render as
>
> kill_dependency(). It could be used as follows
>
> instead of
> kill_dependency(). It could be used as follows:
>
> (note: final colon)

Quoting [1], "The :: may be tacked onto the very end of any
paragraph. The :: will be omitted if it is preceded by whitespace. The
:: will be converted to a single colon if preceded by text"

BR,
Jani.


[1] http://docutils.sourceforge.net/docs/user/rst/quickref.html#literal-blocks



--
Jani Nikula, Intel Open Source Technology Center