aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Audron <audron@cocaine.farm>2021-10-20 17:15:12 +0200
committerMax Audron <audron@cocaine.farm>2021-10-20 17:15:12 +0200
commit2b5c8a5f28828b3448e031cc79c56ffa7a61db0f (patch)
tree30df185fcf1fd5e5fc3bdb6a4dd045b8b68426f5
parentchange hook errors to be logged as warnings (diff)
add async docs to macro crate and bump version
Diffstat (limited to '')
-rw-r--r--Cargo.lock2
-rw-r--r--macros/Cargo.lock7
-rw-r--r--macros/Cargo.toml2
-rw-r--r--macros/src/lib.rs8
4 files changed, 10 insertions, 9 deletions
diff --git a/Cargo.lock b/Cargo.lock
index e68d6e1..dd364d4 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -162,7 +162,7 @@ dependencies = [
[[package]]
name = "catinator_macros"
-version = "0.2.0"
+version = "0.3.0"
dependencies = [
"anyhow",
"catinator",
diff --git a/macros/Cargo.lock b/macros/Cargo.lock
deleted file mode 100644
index 6d255d1..0000000
--- a/macros/Cargo.lock
+++ /dev/null
@@ -1,7 +0,0 @@
-# This file is automatically @generated by Cargo.
-# It is not intended for manual editing.
-version = 3
-
-[[package]]
-name = "macros"
-version = "0.1.0"
diff --git a/macros/Cargo.toml b/macros/Cargo.toml
index 7757e3b..59cfd73 100644
--- a/macros/Cargo.toml
+++ b/macros/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "catinator_macros"
-version = "0.2.0"
+version = "0.3.0"
edition = "2018"
description = "proc macros for catinator"
license = "ISC"
diff --git a/macros/src/lib.rs b/macros/src/lib.rs
index 7c5ce19..4a37958 100644
--- a/macros/src/lib.rs
+++ b/macros/src/lib.rs
@@ -91,6 +91,14 @@ fn generate_help(items: &Items) -> proc_macro2::TokenStream {
/// }
/// ```
///
+/// ## async
+/// You can run async functions natively by prepending your function
+/// hooks etc. with the async keyword.
+///
+/// ```ignore
+/// async hook("name", "description", COMMAND, function)
+/// ```
+///
/// ## hook
/// Hooks execute a function when a specific IRC Command is received,
/// this allows for great flexibility in hooking into IRC for Authentication and the likes.