docs: inline comment

Co-authored-by: Marek Kaput <[email protected]>
keep-starknet-strange · Aug 21, 2024 · a1c694e · a1c694e
1 parent 4f9f54e
commit a1c694e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/macros/src/lib.rs b/packages/macros/src/lib.rs
@@ -3,6 +3,14 @@ use cairo_lang_macro::{inline_macro, Diagnostic, ProcMacroResult, TokenStream};
 use cairo_lang_parser::utils::SimpleParserDatabase;
 use cairo_lang_syntax::node::kind::SyntaxKind::Arg;
 
+/// Compile-time power function.
+///
+/// Takes two arguments, `x, y`, calculates the value of `x` raised to the power of `y`.
+///
+/// ```
+/// const MEGABYTE: u64 = pow!(2, 20);
+/// assert_eq!(MEGABYTE, 1048576);
+/// ```
 #[inline_macro]
 pub fn pow(token_stream: TokenStream) -> ProcMacroResult {
     let db = SimpleParserDatabase::default();