Add notes to logistic_curve_rhs/1

elixir-image · Jul 23, 2024 · e595799 · e595799
1 parent 6fdb6c1
commit e595799
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/image.ex b/lib/image.ex
@@ -8744,6 +8744,12 @@ defmodule Image do
   * A single band `t:Vimage.t/0` representing the right hand side
     (positive numbers) of the logistic curve.
 
+  ### Notes
+
+  * This is not a general purpose curve generator. It is used by
+    `Image.vibrance/3` and may, in the future, be developed into a more
+    general purpose logistic curve function.
+
   """
   # See https://github.com/libvips/libvips/discussions/4039
   @doc since: "0.54.0"