[PATCH] hwmon: (sht3x) Fix alarm attribute names in documentation

[PATCH] hwmon: (sht3x) Fix alarm attribute names in documentation

[Wayne Ho]

The description of the periodic measure mode says that "the alert
attribute" is set when a reading exceeds the configured limits. The
driver has no such attribute, and never had one. The alarm state has
been exposed through temp1_alarm and humidity1_alarm since the driver
was added, which is also what the sysfs interface table further down in
the same document lists.

Refer to the actual attribute names.

Fixes: 7c84f7f80d6f ("hwmon: add support for Sensirion SHT3x sensors")
Signed-off-by: Wayne Ho <wayneho219@gmail.com>
---
 Documentation/hwmon/sht3x.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/hwmon/sht3x.rst b/Documentation/hwmon/sht3x.rst
index 4f67671eb0c..3c022c058be 100644
--- a/Documentation/hwmon/sht3x.rst
+++ b/Documentation/hwmon/sht3x.rst
@@ -78,11 +78,11 @@ The allowed update_interval in milliseconds are as follows:
 
 In the periodic measure mode, the sensor automatically triggers a measurement
 with the configured update interval on the chip. When a temperature or humidity
-reading exceeds the configured limits, the alert attribute is set to 1 and
-the alert pin on the sensor is set to high.
+reading exceeds the configured limits, the temp1_alarm or humidity1_alarm
+attribute is set to 1 and the alert pin on the sensor is set to high.
 When the temperature and humidity readings move back between the hysteresis
-values, the alert bit is set to 0 and the alert pin on the sensor is set to
-low.
+values, the alarm attribute is set to 0 and the alert pin on the sensor is set
+to low.
 
 The serial number exposed to debugfs allows for unique identification of the
 sensors. For sts32, sts33 and sht33, the manufacturer provides calibration

---
base-commit: 44c8ceae2dd3ae536c5f4f956cedb24c157aac23
change-id: 20261112-sht3x-doc-alarm-attr-118ddfebc6ae

Best regards,
--  
Wayne Ho <wayneho219@gmail.com>

Re: [PATCH] hwmon: (sht3x) Fix alarm attribute names in documentation

[sashiko-bot]

> The description of the periodic measure mode says that "the alert
> attribute" is set when a reading exceeds the configured limits. The
> driver has no such attribute, and never had one. The alarm state has
> been exposed through temp1_alarm and humidity1_alarm since the driver
> was added, which is also what the sysfs interface table further down in
> the same document lists.
> 
> Refer to the actual attribute names.
> 
> Fixes: 7c84f7f80d6f ("hwmon: add support for Sensirion SHT3x sensors")
> Signed-off-by: Wayne Ho <wayneho219@gmail.com>

Sashiko has reviewed this patch and found no issues.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261112-sht3x-doc-alarm-attr-v1-1-91676362d133@gmail.com?part=1