Skip to content

Commit d71edab

Browse files
committed
Make note about not using from_binary/2 more prominent
1 parent 72f62dc commit d71edab

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

lib/image.ex

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,18 +1084,18 @@ defmodule Image do
10841084
* `options` is a keyword list of options. See `Image.open/2`
10851085
for the list of applicable options.
10861086
1087-
### Notes
1088-
1089-
This function is typically *not* the best way to open
1090-
an image. It requires that the entire image
1091-
is already loaded into memory which, for most use cases,
1092-
doest not scale well and consumes far more memory than
1093-
necessary.
1094-
1095-
Since `libvips` is a streaming on-demand architecture,
1096-
it is most likely that a simple `Image.open/2` call will
1097-
deliver better resource utilitsation and equal or better
1098-
performance.
1087+
> #### Note {: .info}
1088+
>
1089+
> This function is typically *not* the best way to open
1090+
> an image. It requires that the entire image
1091+
> is already loaded into memory which, for most use cases,
1092+
> doest not scale well and consumes far more memory than
1093+
> necessary.
1094+
>
1095+
> Since `libvips` is a streaming on-demand architecture,
1096+
> it is most likely that a simple `Image.open/2` call will
1097+
> deliver better resource utilitsation and equal or better
1098+
> performance.
10991099
11001100
### Returns
11011101

0 commit comments

Comments
 (0)