Am 14.09.2016 um 09:45 schrieb Jean Delvare <jdelv...@suse.de>: > On Tue, 13 Sep 2016 16:24:48 -0300, Mauro Carvalho Chehab wrote: >> Em Tue, 13 Sep 2016 19:45:23 +0200 >> Jean Delvare <jdelv...@suse.de> escreveu: >> >>> Hi Mauro, >>> >>> On Mon, 12 Sep 2016 11:47:57 -0300, Mauro Carvalho Chehab wrote: >>>> Instead of using "foo", use ``foo`` for the names that are >>>> literal. >>> >>> Because...? >> >> Because it is an usual typographic convention to use monospaced >> fonts for functions and language commands on documents. >> >> On Sphinx/ReST, ``foo`` means that foo will be displayed using a >> monospaced font. > > My point was that such an explanation should be part of your patch > description,
IMHO """use ``foo`` for the names that are **literal**""" is enough. -- Markus -- > so that the change can be accepted (is the reviewer agrees > with your reason) or discussed (if he/she doesn't.) > > And I do agree with the change, for what it's worth :-) > > Thanks, > -- > Jean Delvare > SUSE L3 Support > -- > To unsubscribe from this list: send the line "unsubscribe linux-doc" in > the body of a message to majord...@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
