Skip to content

Commit d8cee7b

Browse files
committed
Improve docs
1 parent daa0a54 commit d8cee7b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

lib/image/math.ex

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -813,12 +813,10 @@ defmodule Image.Math do
813813
814814
* `image` is any `t:Vix.Vips.Image.t/0`.
815815
816-
* `options` is a keyword list of options.
817-
818-
### Options
819-
820-
* `:n` is the number of maximums to find. The
821-
default is `10`.
816+
* `n` is the number of maxima to find. The
817+
default is `10`. Maxima in this case means the
818+
largest `n` values; They may not be equal to the
819+
maximum.
822820
823821
### Returns
824822
@@ -849,7 +847,9 @@ defmodule Image.Math do
849847
* `image` is any `t:Vix.Vips.Image.t/0`.
850848
851849
* `n` is the number of minima to find. The
852-
default is `10`.
850+
default is `10`. Minima in this case means the
851+
smallest `n` values; They may not be equal to the
852+
minimum.
853853
854854
### Returns
855855
@@ -881,7 +881,9 @@ defmodule Image.Math do
881881
* `image` is any `t:Vix.Vips.Image.t/0`.
882882
883883
* `n` is the number of maxima to find. The
884-
default is `10`.
884+
default is `10`. Maxima in this case means
885+
those values that exactly match the maximum
886+
value.
885887
886888
### Returns
887889
@@ -955,12 +957,10 @@ defmodule Image.Math do
955957
956958
* `image` is any `t:Vix.Vips.Image.t/0`.
957959
958-
* `options` is a keyword list of options.
959-
960-
### Options
961-
962-
* `:n` is the number of minima to find. The
963-
default is `10`.
960+
* `n` is the number of minima to find. The
961+
default is `10`. Minima in this case means
962+
those values that exactly match the maximum
963+
value.
964964
965965
### Returns
966966

0 commit comments

Comments
 (0)