Merge pull request #3757 from endersstocker/update-hd-doc

josevalim · josevalim · commit 34c37ab023e9 · 2015-09-21T09:55:18.000+02:00
Update doc for Kernel.hd/1 to indicate guard clause utility
diff --git a/lib/elixir/lib/kernel.ex b/lib/elixir/lib/kernel.ex
@@ -244,7 +244,7 @@ defmodule Kernel do
   @doc """
   Returns the head of a list; raises `ArgumentError` if the list is empty.
 
-  Inlined by the compiler.
+  Allowed in guard tests. Inlined by the compiler.
 
   ## Examples
 
