Re: [PATCH 06/17] CodingStyle.rst: use the proper tag for verbatim font

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, 14 Sep 2016 10:48:33 -0300, Mauro Carvalho Chehab wrote:
> Ok, what about using this comment for the patch?
> 
> Documentation/CodingStyle: use the proper tag for verbatim font
> 
> On Sphinx/ReST notation, ``foo`` means that foo will be will be 
> marked as inline literal, effectively making it	to be presented
> as a monospaced font.
> 
> As we want this document to be parsed by Sphinx, instead of using
> "foo", use ``foo`` for the names that are literal, because it is an
> usual typographic convention to use monospaced fonts for functions
> and language commands on documents, and we're following such
> convention on the other ReST books.

Fine with me, thanks Mauro.

-- 
Jean Delvare
SUSE L3 Support
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux