Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Re-organising repo #169

Closed
wants to merge 10 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update crate docs.
thejpster committed Nov 24, 2019

Verified

This commit was signed with the committer’s verified signature.
snyk-bot Snyk bot
commit 20550b1b1ff998c6a2754a69600a69fd5573686e
6 changes: 5 additions & 1 deletion embedded-hal-delay/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
//! Delays
//! # embedded-hal-delay
//!
//! Traits for busy-waiting for specified periods of time. You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.
//!
//! # What's the difference between these traits and the `timer::CountDown` trait?
//!
2 changes: 1 addition & 1 deletion embedded-hal-digital/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! # embedded-hal-digital
//!
//! Contains digital GPIO pin traits. You should use the
//! Traits for writing and reading digital GPIO pins. You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.

7 changes: 6 additions & 1 deletion embedded-hal-i2c/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
//! # embedded-hal-i2c
//!
//! Traits for I2C (Inter-IC) Interface Masters
//! Traits for driving a Inter-IC (I2C) bus so as to access the other devices
//! on that bus. You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.
//!
//! This is currently only available as a blocking API.

#![deny(missing_docs)]
#![no_std]
8 changes: 7 additions & 1 deletion embedded-hal-serial/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
//! Serial interface
//! # embedded-hal-serial
//!
//! Traits for driving a Serial interface (also known as a UART). You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.
//!
//! Available in both blocking and non-blocking variants.

#![deny(missing_docs)]
#![no_std]
9 changes: 8 additions & 1 deletion embedded-hal-spi/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
//! Serial Peripheral Interface
//! # embedded-hal-spi
//!
//! Traits for driving a Serial Peripheral Interface (SPI) device for the
//! purposes of accessing other devices on that bus. You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.
//!
//! Available in both blocking and non-blocking variants.

#![deny(missing_docs)]
#![no_std]
8 changes: 7 additions & 1 deletion embedded-hal-timer/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
//! Timers
//! # embedded-hal-timer
//!
//! Traits for measuring elapsed periods of time. You should use the
//! [`embedded-hal`](https://crates.io/crates/embedded-hal) crate if you want
//! a stable version.
//!
//! This API is non-blocking.

#![deny(missing_docs)]
#![no_std]