Skip to content

Commit 6df1fa8

Browse files
committed
some docstrings
1 parent 8d4a04d commit 6df1fa8

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/blocking/dac.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
//! Trait for digital to analog conversion
1+
//! Blocking DAC trait for single channel digital to analog conversion
22
3-
/// Represents a single DAC channel.
3+
/// A single DAC channel. Word is the type used to represent a single sample, this would typically
4+
/// be u8, u16 or u32.
5+
/// Note that not all bits will always be used. A 12 bit DAC for example will probably use u16 here
6+
/// <DISCUSSION> should we prescribe to use the most significant bits here for compat between word
7+
/// sizes?
48
pub trait DAC<WORD> {
59
/// Error type returned by DAC methods
610
type Error;

0 commit comments

Comments
 (0)