Skip to content

Commit

Permalink
Add reference to microbit-v2 example in rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
hdoordt committed Jun 24, 2024
1 parent 08fa5ab commit 04d589b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
//! This is a platform agnostic Rust driver for the LSM303AGR ultra-compact
//! high-performance eCompass module: ultra-low-power 3D accelerometer and
//! 3D magnetometer using the [`embedded-hal`] traits.
//! This driver also supports the [`embedded-hal-async`] traits if the `async` feature is enabled.
//!
//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
//!
Expand Down Expand Up @@ -100,6 +101,9 @@
//! }
//! # }
//! ```
//!
//! For an example of using the async support of this driver on a micro:bit V2,
//! have a look at [microbit-v2 example](https://github.com/eldruin/lsm303agr-rs/blob/master/examples/microbit-v2.rs)
#![deny(unsafe_code, missing_docs)]
#![allow(async_fn_in_trait)]
Expand Down

0 comments on commit 04d589b

Please sign in to comment.