Add information about short-circuting (#1343)

elixir-nx · Oct 16, 2023 · 0ebeb81 · 0ebeb81
1 parent 7e59f9f
commit 0ebeb81
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/nx/lib/nx.ex b/nx/lib/nx.ex
@@ -6205,6 +6205,8 @@ defmodule Nx do
   If you're using `Nx.Defn.defn/2`, you can use the `&&&` operator
   in place of this function: `left &&& right`.
 
+  It does not support short-circuiting.
+
   ## Examples
 
   ### bitwise and between scalars
@@ -6258,6 +6260,8 @@ defmodule Nx do
   If you're using `Nx.Defn.defn/2`, you can use the `|||` operator
   in place of this function: `left ||| right`.
 
+  It does not support short-circuiting.
+
   ## Examples
 
   ### bitwise or between scalars

diff --git a/nx/lib/nx/defn/kernel.ex b/nx/lib/nx/defn/kernel.ex
@@ -522,6 +522,8 @@ defmodule Nx.Defn.Kernel do
 
   It delegates to `Nx.logical_and/2` (supports broadcasting).
 
+  It does not support short-circuiting.
+
   ## Examples
 
       defn and_or(a, b) do
@@ -548,6 +550,8 @@ defmodule Nx.Defn.Kernel do
 
   It delegates to `Nx.logical_or/2` (supports broadcasting).
 
+  It does not support short-circuiting.
+
   ## Examples
 
       defn and_or(a, b) do