Tweak docs

kevinschweikert · Jun 18, 2024 · 48890b0 · 48890b0
1 parent ec78b34
commit 48890b0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/lib/curl_req.ex b/lib/curl_req.ex
@@ -54,7 +54,7 @@ defmodule CurlReq do
 
   Options:
 
-  - `run_steps`: Run the Req.Steps before generation the arguments. Default: `true`
+  - `run_steps`: Run the Req.Steps before generating the curl command. Default: `true`. This option is semi-private, introduced to support CurlReq.Plugin.
   - `flags`: Specify the style the argument flags are constructed. Can either be `:short` or `:long`, Default: `:short`
 
   ## Examples

diff --git a/lib/curl_req/plugin.ex b/lib/curl_req/plugin.ex
@@ -4,6 +4,10 @@ defmodule CurlReq.Plugin do
   @moduledoc """
   A collection of steps, usable with Req.
 
+  > #### Info {: .info}
+  >
+  > This plugin needs to be added behind any other Req.Steps. Steps add headers and change the request, and this all has to be done _before_ converting the request to a curl command.
+
   ## Examples
 
       iex> Req.new(url: "https://catfact.ninja/fact")