Skip to content

Commit dbe7fa8

Browse files
Add more details on the effects of the disable function
1 parent 65cbd22 commit dbe7fa8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

nrf-hal-common/src/twim.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ where
8787
}
8888

8989
/// Disable the instance.
90+
///
91+
/// Disabling the instance will switch off the peripheral leading to a
92+
/// considerably lower energy use. However, while the instance is disabled
93+
/// it is not possible to use it for communication. The configuration of
94+
/// the instance will be retained.
9095
pub fn disable(&mut self) {
9196
self.0.enable.write(|w| w.enable().disabled());
9297
}

0 commit comments

Comments
 (0)