From 905f4857d9fdaba614d625c5ced4ea4bc7f4b2dd Mon Sep 17 00:00:00 2001 From: Thorsten von Eicken Date: Thu, 8 Sep 2016 23:28:20 -0700 Subject: [PATCH] minor documentation addition --- gpio.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/gpio.go b/gpio.go index 26bd866..3d7baf7 100644 --- a/gpio.go +++ b/gpio.go @@ -33,7 +33,11 @@ const ( EdgeBoth Edge = "both" ) -// InterruptPin implements access to a Interruptable capable GPIO pin. +// InterruptPin implements access to an interrupt capable GPIO pin. +// The basic capability provided is to watch for a transition on the pin and +// generate a callback to a handler when a transition occurs. +// On Linux the underlying implementation generally uses epoll to receive the +// interrupts at user-level. type InterruptPin interface { // Start watching this pin for interrupt