Improve Plugin docs

derekkraan · Jun 16, 2024 · d92bc9a · d92bc9a
1 parent 7ba8e9f
commit d92bc9a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/curl_req/plugin.ex b/lib/curl_req/plugin.ex
@@ -31,7 +31,10 @@ defmodule CurlReq.Plugin do
     request
   end
 
+  @type option :: {:log_level, Logger.level()} | {:log_metadata, any()}
+
   @doc "Attaches the plugin, main entry point for this module."
+  @spec attach(Req.Request.t(), [option()]) :: Req.Request.t()
   def attach(%Req.Request{} = request, options \\ []) do
     request
     |> Req.Request.register_options([:log_level, :log_metadata])