diff --git a/documentation/API-GUIDELINES.md b/documentation/API-GUIDELINES.md index 5f5f21c39a..ca4b86566c 100644 --- a/documentation/API-GUIDELINES.md +++ b/documentation/API-GUIDELINES.md @@ -80,6 +80,8 @@ In general, the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines - If a driver only implements a subset of a peripheral's capabilities, it should be placed in the `peripheral::subcategory` module. - For example, if a driver implements the slave-mode I2C driver, it should be placed into `i2c::slave`. - This helps us reducing the need of introducing breaking changes if we implement additional functionalities. +- Avoid abbreviations and contractions in the API, where possible. + - Saving a few characters may introduce ambiguity, e.g `SpiTransDone`, is it `Transmit` or `Transfer`? ## Maintainability diff --git a/esp-hal/src/i2c/master/mod.rs b/esp-hal/src/i2c/master/mod.rs index 8fa40dca19..6427dd8eef 100644 --- a/esp-hal/src/i2c/master/mod.rs +++ b/esp-hal/src/i2c/master/mod.rs @@ -99,7 +99,7 @@ pub enum Error { /// The arbitration for the bus was lost. ArbitrationLost, /// The execution of the I2C command was incomplete. - ExecIncomplete, + ExecutionIncomplete, /// The number of commands issued exceeded the limit. CommandNrExceeded, /// Zero length read or write operation.