image icon indicating copy to clipboard operation
image copied to clipboard

The documentation on `crop()` is confusing

Open Shnatsel opened this issue 6 months ago • 1 comments

See https://docs.rs/image/0.25.2/image/enum.DynamicImage.html#method.crop

In image v0.25.2 the documentation for crop() states:

Note: this method does not modify the object, and its signature will be replaced with crop_imm()’s in the 0.24 release

It also took me a while to get what "does not modify the object" actually refers to. At first I thought that maybe it returns a view into the image or something. But no, it actually returns a different buffer altogether.

It's weird that it talks about 0.24 as if it's in the future in docs for v0.25. And the signatures are still different. I guess that's a work item for 0.26 now.

Shnatsel avatar Jul 28 '24 19:07 Shnatsel