Add docs to Kernel.if/2

qdentity · Nov 20, 2023 · 023361a · 023361a
1 parent df66d88
commit 023361a
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/lib/elixir/lib/kernel.ex b/lib/elixir/lib/kernel.ex
@@ -3773,11 +3773,13 @@ defmodule Kernel do
     var
   end
 
-  @doc """
+  @doc ~S"""
   Provides an `if/2` macro.
 
   This macro expects the first argument to be a condition and the second
-  argument to be a keyword list.
+  argument to be a keyword list. Similar to `case/2`, any assignment in
+  the condition will be available on both clauses, as well as after the
+  if statement.
 
   ## One-liner examples