From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jean Delvare Subject: Re: [PATCH 15/26] docs: i2c: smbus-protocol: enable kernel-doc function syntax Date: Mon, 20 Jan 2020 15:44:44 +0100 Message-ID: <20200120154444.7c1d3863@endymion> References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200105225012.11701-1-luca@lucaceresoli.net> <20200105225012.11701-15-luca@lucaceresoli.net> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20200105225012.11701-15-luca@lucaceresoli.net> Sender: linux-doc-owner@vger.kernel.org To: Luca Ceresoli Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org, Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org List-Id: linux-i2c@vger.kernel.org On Sun, 5 Jan 2020 23:50:01 +0100, Luca Ceresoli wrote: > Hyperlinks from function names are not generated in headings. Move them in > the plain text so they are rendered as clickable hyerlinks. typo: hyperlinks > > While there also remove an unneeded colon in a heading. > > Signed-off-by: Luca Ceresoli > --- > Documentation/i2c/smbus-protocol.rst | 64 ++++++++++++++++++---------- > 1 file changed, 42 insertions(+), 22 deletions(-) > > diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst > index 10c4a989982c..997945e90419 100644 > --- a/Documentation/i2c/smbus-protocol.rst > +++ b/Documentation/i2c/smbus-protocol.rst > @@ -62,8 +62,10 @@ This sends a single bit to the device, at the place of the Rd/Wr bit:: > Functionality flag: I2C_FUNC_SMBUS_QUICK > > > -SMBus Receive Byte: i2c_smbus_read_byte() > -========================================== > +SMBus Receive Byte > +================== > + > +Implemented by i2c_smbus_read_byte() In file i2c-protocol.rst, the wording used is: This corresponds to i2c_transfer(). For consistency, can we settle for "Implemented by foo()" everywhere? Reviewed-by: Jean Delvare -- Jean Delvare SUSE L3 Support