pw_i2c: Use inclusive language
Bug: 386
Change-Id: Icf103854125c9cd66ef87aa9e2bdca57ddce4c6b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/46682
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
diff --git a/pw_i2c/device_test.cc b/pw_i2c/device_test.cc
index 50a7c81..00b4829 100644
--- a/pw_i2c/device_test.cc
+++ b/pw_i2c/device_test.cc
@@ -20,7 +20,7 @@
namespace i2c {
namespace {
-// Dummy test initiator that's used for testing.
+// Fake test initiator that's used for testing.
class TestInitiator : public Initiator {
public:
explicit TestInitiator() {}
diff --git a/pw_i2c/docs.rst b/pw_i2c/docs.rst
index 9129edc..60e04c2 100644
--- a/pw_i2c/docs.rst
+++ b/pw_i2c/docs.rst
@@ -15,10 +15,14 @@
pw::i2c::Initiator
------------------
+.. inclusive-language: disable
+
The common interface for initiating transactions with devices on an I2C bus.
Other documentation sources may call this style of interface an I2C "master",
"central" or "controller".
+.. inclusive-language: enable
+
pw::i2c::Device
---------------
The common interface for interfacing with generic I2C devices. This object
@@ -74,4 +78,4 @@
// Optionally check if the mocked transaction list has been exhausted.
// Alternatively this is also called from MockInitiator::~MockInitiator().
- EXPECT_EQ(mocked_i2c.Finalize(), OkStatus());
\ No newline at end of file
+ EXPECT_EQ(mocked_i2c.Finalize(), OkStatus());
diff --git a/pw_i2c/public/pw_i2c/initiator.h b/pw_i2c/public/pw_i2c/initiator.h
index bbcf9a5..923852f 100644
--- a/pw_i2c/public/pw_i2c/initiator.h
+++ b/pw_i2c/public/pw_i2c/initiator.h
@@ -24,7 +24,7 @@
// Base driver interface for I2C initiating I2C transactions in a thread safe
// manner. Other documentation sources may call this style of interface an I2C
-// "master", "central" or "controller".
+// "master", "central" or "controller". // inclusive-language: ignore
//
// The Initiator is not required to support 10bit addressing. If only 7bit
// addressing is supported, the Initiator will assert when given an address
@@ -177,7 +177,7 @@
// enabled.
Status ProbeDeviceFor(Address device_address,
chrono::SystemClock::duration for_at_least) {
- std::byte ignored_buffer[1] = {}; // Read a dummy byte to probe.
+ std::byte ignored_buffer[1] = {}; // Read a byte to probe.
return WriteReadFor(
device_address, ConstByteSpan(), ignored_buffer, for_at_least);
}
