[PATCH 8/9] docs: i2c: i2c-sysfs: improve wording

luca.ceresoli@bootlin.com posted 9 patches 3 years, 8 months ago
There is a newer version of this series
[PATCH 8/9] docs: i2c: i2c-sysfs: improve wording
Posted by luca.ceresoli@bootlin.com 3 years, 8 months ago
From: Luca Ceresoli <luca.ceresoli@bootlin.com>

Improve wording in a couple sentences.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 Documentation/i2c/i2c-sysfs.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/i2c/i2c-sysfs.rst b/Documentation/i2c/i2c-sysfs.rst
index 6b68b95cd427..d816a23b80f2 100644
--- a/Documentation/i2c/i2c-sysfs.rst
+++ b/Documentation/i2c/i2c-sysfs.rst
@@ -51,11 +51,10 @@ Google Pixel 3 phone for example::
 ``i2c-2`` is an I2C bus whose number is 2, and ``2-0049`` is an I2C device
 on bus 2 address 0x49 bound with a kernel driver.
 
-Terminologies
-=============
+Terminology
+===========
 
-First, let us define a couple of terminologies to avoid confusions in the later
-sections.
+First, let us define some terms to avoid confusions in the later sections.
 
 (Physical) I2C Bus Controller
 -----------------------------
@@ -117,7 +116,7 @@ Walk through Logical I2C Bus
 
 For the following content, we will use a more complex I2C topology as an
 example. Here is a brief graph for the I2C topology. If you do not understand
-this graph at the first glance, do not be afraid to continue reading this doc
+this graph at first glance, do not be afraid to continue reading this doc
 and review it when you finish reading.
 
 ::
-- 
2.34.1
Re: [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording
Posted by Wolfram Sang 3 years, 8 months ago
> -First, let us define a couple of terminologies to avoid confusions in the later
> -sections.
> +First, let us define some terms to avoid confusions in the later sections.

Does 'confusion' have a plural? I think singular is better here.

Rest looks good.

Re: [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording
Posted by Wolfram Sang 3 years, 8 months ago
> Does 'confusion' have a plural? I think singular is better here.

I took the liberty to fix it myself so we can have the patch in rc1
already. I hope this is fine with you.

Re: [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording
Posted by Luca Ceresoli 3 years, 8 months ago
Hi Wolfram,

On Thu, 11 Aug 2022 23:23:12 +0200
Wolfram Sang <wsa@kernel.org> wrote:

> > Does 'confusion' have a plural? I think singular is better here.  
> 
> I took the liberty to fix it myself so we can have the patch in rc1
> already. I hope this is fine with you.

Sure, thank you!

-- 
Luca Ceresoli, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com