Add async usage guidance for attribute macro

allan2 · Oct 5, 2024 · 85e13d1 · 85e13d1
1 parent 5508e50
commit 85e13d1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/dotenvy-macros/src/lib.rs b/dotenvy-macros/src/lib.rs
@@ -13,6 +13,8 @@ use syn::{
 /// Three optional arguments are supported: `path`, `required`, and `override_`.
 /// Usage is like `#[dotenvy::load(path = ".env", required = true, override_ = true)]`.
 ///
+/// When using in an async runtime, `load` must be placed above async runtime spawning macros such as `tokio::main`.
+///
 /// The default path is "./.env". The default sequence is `EnvSequence::InputThenEnv`.
 #[proc_macro_attribute]
 pub fn load(attr: TokenStream, item: TokenStream) -> TokenStream {