Merge branch 'doc/fix_i2c_typo' into 'master'

Vorrad · Vorrad · commit 00e5effb4235 · 2025-08-29T16:01:29.000+08:00
docs(i2c_master): Fix a typo in description

Closes IDFGH-16329

See merge request espressif/esp-idf!41439
diff --git a/components/esp_driver_i2c/include/driver/i2c_master.h b/components/esp_driver_i2c/include/driver/i2c_master.h
@@ -236,7 +236,7 @@ esp_err_t i2c_master_receive(i2c_master_dev_handle_t i2c_dev, uint8_t *read_buff
  * @param[in] address I2C device address that you want to probe.
  * @param[in] xfer_timeout_ms Wait timeout, in ms. Note: -1 means wait forever (Not recommended in this function).
  *
- * @attention Pull-ups must be connected to the SCL and SDA pins when this function is called. If you get `ESP_ERR_TIMEOUT
+ * @attention Pull-ups must be connected to the SCL and SDA pins when this function is called. If you get `ESP_ERR_TIMEOUT`
  * while `xfer_timeout_ms` was parsed correctly, you should check the pull-up resistors. If you do not have proper resistors nearby.
  * `flags.enable_internal_pullup` is also acceptable.
  *

Original file line number	Diff line number	Diff line change
`@@ -236,7 +236,7 @@ esp_err_t i2c_master_receive(i2c_master_dev_handle_t i2c_dev, uint8_t *read_buff`
`236`	`236`	`* @param[in] address I2C device address that you want to probe.`
`237`	`237`	`* @param[in] xfer_timeout_ms Wait timeout, in ms. Note: -1 means wait forever (Not recommended in this function).`
`238`	`238`	`*`
`239`		- * @attention Pull-ups must be connected to the SCL and SDA pins when this function is called. If you get `ESP_ERR_TIMEOUT
	`239`	+ * @attention Pull-ups must be connected to the SCL and SDA pins when this function is called. If you get `ESP_ERR_TIMEOUT`
`240`	`240`	* while `xfer_timeout_ms` was parsed correctly, you should check the pull-up resistors. If you do not have proper resistors nearby.
`241`	`241`	* `flags.enable_internal_pullup` is also acceptable.
`242`	`242`	`*`