From 5d141562766d95d882f9dbce1f0722ea8fbf744d Mon Sep 17 00:00:00 2001
From: tsai <jackalcooper@gmail.com>
Date: Mon, 7 Oct 2024 07:27:00 +0800
Subject: [PATCH] More docs on intrinsic

---
 lib/charms/intrinsic.ex | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/lib/charms/intrinsic.ex b/lib/charms/intrinsic.ex
index cba82aa..5fc32f6 100644
--- a/lib/charms/intrinsic.ex
+++ b/lib/charms/intrinsic.ex
@@ -5,7 +5,19 @@ defmodule Charms.Intrinsic do
   alias Beaver
   @type opt :: {:ctx, MLIR.Context.t()} | {:block, MLIR.Block.t()}
   @type opts :: [opt | {atom(), term()}]
-  @callback handle_intrinsic(atom(), [term()], opts()) :: term()
+  @type ir_return :: MLIR.Value.t() | MLIR.Operation.t()
+  @type intrinsic_return :: ir_return() | (any() -> ir_return())
+  @doc """
+  Callback to implement an intrinsic.
+
+  Having different return types, there are two kinds of intrinsic functions:
+  - Regular: returns a MLIR value or operation.
+  - Higher-order: returns a function that returns a MLIR value or operation.
+
+  ## More on higher-order intrinsic
+  Higher-order intrinsic function can be variadic, which means it a list will be passed as arguments.
+  """
+  @callback handle_intrinsic(atom(), [term()], opts()) :: intrinsic_return()
   Module.register_attribute(__MODULE__, :defintrinsic, accumulate: true)
 
   @doc false