Skip to content

Commit 415db11

Browse files
committed
doc(hidden), rm changelog
1 parent e5fcf6c commit 415db11

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

esp-hal/CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3535
- Adjusted ESP32-S2 and ESP-S3 memory region lengths to reflect those defined in ESP-IDF. (#3709)
3636
- Changed the various `ConfigError` variant names to use a consistent word order. (#3782)
3737
- Adjusted ESP32-S2 deep-sleep to hibernate for the Ext1WakeupSource (#3785)
38-
- Blocking RMT transactions can now be `poll`ed without blocking, returning whether they have completed. (#3716)
3938

4039
### Fixed
4140

esp-hal/src/rmt.rs

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,11 +1061,12 @@ where
10611061
status
10621062
}
10631063

1064-
/// Check transmission status and write new data to the hardware if
1065-
/// necessary.
1066-
///
1067-
/// Returns whether transmission has ended (whether successfully or with an
1068-
/// error). In that case, a subsequent call to `wait()` returns immediately.
1064+
// Check transmission status and write new data to the hardware if
1065+
// necessary.
1066+
//
1067+
// Returns whether transmission has ended (whether successfully or with an
1068+
// error). In that case, a subsequent call to `wait()` returns immediately.
1069+
#[doc(hidden)]
10691070
#[cfg_attr(place_rmt_driver_in_ram, ram)]
10701071
pub fn poll(&mut self) -> bool {
10711072
match self.poll_internal() {
@@ -1353,10 +1354,11 @@ impl<Raw: RxChannelInternal> RxTransaction<'_, Raw> {
13531354
status
13541355
}
13551356

1356-
/// Check receive status
1357-
///
1358-
/// Returns whether reception has ended (whether successfully or with an
1359-
/// error). In that case, a subsequent call to `wait()` returns immediately.
1357+
// Check receive status
1358+
//
1359+
// Returns whether reception has ended (whether successfully or with an
1360+
// error). In that case, a subsequent call to `wait()` returns immediately.
1361+
#[doc(hidden)]
13601362
#[cfg_attr(place_rmt_driver_in_ram, ram)]
13611363
pub fn poll(&mut self) -> bool {
13621364
match self.poll_internal() {

0 commit comments

Comments
 (0)