docs: Orb.Import.defw example

RoyalIcing · Jun 18, 2024 · c5e7ca1 · c5e7ca1
1 parent df60597
commit c5e7ca1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/orb/import.ex b/lib/orb/import.ex
@@ -47,6 +47,16 @@ defmodule Orb.Import do
 
     @doc """
     Declare the name and signature of function that will be imported.
+
+    ```elixir
+    defmodule Log do
+      use Orb.Import
+
+      defw(int32(a: I32))
+      defw(int64(a: I64))
+      defw(two_int32(a: I32, b: I32))
+    end
+    ```
     """
     defmacro defw(call, result_type \\ nil) do
       alias Elixir.Orb.{Func, Import}