Wrote Minimal Documentation for the Lambda Macro (#71)

alex-ozdemir · davidbarsky · commit a2aeb2c9cb66 · 2019-01-20T14:57:10.000-05:00
diff --git a/lambda-runtime/src/runtime.rs b/lambda-runtime/src/runtime.rs
@@ -45,6 +45,9 @@ where
 }
 
 #[macro_export]
+/// Starts an event listener which will parse incoming events into the even type requested by
+/// `handler` and will invoke `handler` on each incoming event. Can optionally be passed a Tokio
+/// `runtime` to build the listener on. If none is provided, it creates its own.
 macro_rules! lambda {
     ($handler:ident) => {
         $crate::start($handler, None)

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ where`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`#[macro_export]`
	`48`	`+/// Starts an event listener which will parse incoming events into the even type requested by`
	`49`	+/// `handler` and will invoke `handler` on each incoming event. Can optionally be passed a Tokio
	`50`	+/// `runtime` to build the listener on. If none is provided, it creates its own.
`48`	`51`	`macro_rules! lambda {`
`49`	`52`	`($handler:ident) => {`
`50`	`53`	`$crate::start($handler, None)`