Skip to content

Commit

Permalink
Fix Nightly doc build errors
Browse files Browse the repository at this point in the history
  • Loading branch information
kaidokert committed May 26, 2024
1 parent 4027f8a commit 585d5b7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
1 change: 1 addition & 0 deletions hal/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- Allow configuring USB clock with `GenericClockController` on atsamd11
- fix samd51j not having i2s support
- remove i2s functionality for samd51g since it does not have it
- Fix docbuild indentation errors with nightly toolchain

# v0.17.0

Expand Down
16 changes: 8 additions & 8 deletions hal/src/dmac/transfer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
//! Four basic transfer types are supported:
//!
//! * Incrementing-source to incrementing-destination
//! (normally used for memory-to-memory transfers)
//! (normally used for memory-to-memory transfers)
//!
//! * Incrementing-source to fixed-destination (normally used
//! for memory-to-peripheral transfers)
//! for memory-to-peripheral transfers)
//!
//! * Fixed-source to incrementing-destination (normally used for
//! peripheral-to-memory transfers)
//! peripheral-to-memory transfers)
//!
//! * Fixed-source to fixed-destination (normally used for
//! peripheral-to-peripheral transfers)
//! peripheral-to-peripheral transfers)
//!
//! # Beat sizes
//!
Expand Down Expand Up @@ -72,16 +72,16 @@
//!
//! * BLOCK: One trigger required for each block transfer. In the context of
//! this driver,
//! one Transfer is equivalent to one Block transfer.
//! one Transfer is equivalent to one Block transfer.
//!
//! * BEAT: One trigger required for each beat transfer. In the context of this
//! driver, the beat
//! size will depend on the type of buffer used (8, 16 or 32 bits).
//! size will depend on the type of buffer used (8, 16 or 32 bits).
//!
//! * TRANSACTION: One trigger required for a full DMA transaction. this is
//! useful for circular
//! transfers in the context of this driver. One trigger will set off the
//! transaction, that will now run uninterrupted until it is stopped.
//! transfers in the context of this driver. One trigger will set off the
//! transaction, that will now run uninterrupted until it is stopped.
use super::{
channel::{AnyChannel, Busy, CallbackStatus, Channel, ChannelId, InterruptFlags, Ready},
Expand Down
12 changes: 6 additions & 6 deletions hal/src/sercom/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@
//!
//! * [`UndocIoSet1`](pad::UndocIoSet1): Implement an undocumented `IoSet` for
//! PA16, PA17,
//! PB22 & PB23 configured for [`Sercom1`]. The pygamer & feather_m4 use this
//! combination, but it is not listed as valid in the datasheet.
//! PB22 & PB23 configured for [`Sercom1`]. The pygamer & feather_m4 use this
//! combination, but it is not listed as valid in the datasheet.
//!
//! * [`UndocIoSet2`](pad::UndocIoSet2): Implement an undocumented `IoSet` for
//! PA00, PA01,
//! PB22 & PB23 configured for [`Sercom1`]. The itsybitsy_m4 uses this
//! combination, but it is not listed as valid in the datasheet.
//! PB22 & PB23 configured for [`Sercom1`]. The itsybitsy_m4 uses this
//! combination, but it is not listed as valid in the datasheet.
//!
//! * [`PB02`] is I2C-capable according to metro_m4. As such, [`PB02`]
//! implements [`IsI2cPad`].
//! implements [`IsI2cPad`].
//!
//! * [`PB03`] is I2C-capable according to metro_m4. As such, [`PB03`]
//! implements [`IsI2cPad`](pad::IsI2cPad).
//! implements [`IsI2cPad`](pad::IsI2cPad).
//!
//! [`PB02`]: crate::gpio::pin::PB02
//! [`PB03`]: crate::gpio::pin::PB03
Expand Down

0 comments on commit 585d5b7

Please sign in to comment.