Mention interrupt attribute in main crate docs

Fixes #137
rust-embedded · Nov 1, 2018 · 2f2ad09 · 2f2ad09
1 parent 68c56ab
commit 2f2ad09
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/cortex-m-rt/src/lib.rs b/cortex-m-rt/src/lib.rs
@@ -25,6 +25,10 @@
 //! [`#[exception]`]: ../cortex_m_rt_macros/fn.exception.html
 //! [`#[pre_init]`]: ../cortex_m_rt_macros/fn.pre_init.html
 //!
+//! This crate also implements a related attribute called `#[interrupt]`, which allows you
+//! to define interrupt handlers. However, since which interrupts are available depends on the
+//! microcontroller in use, this attribute should be re-exported and used from a device crate.
+//!
 //! # Requirements
 //!
 //! ## `memory.x`