Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document extract & crop methods #2164

Closed
tomprogers opened this issue Apr 13, 2020 · 3 comments
Closed

document extract & crop methods #2164

tomprogers opened this issue Apr 13, 2020 · 3 comments
Labels

Comments

@tomprogers
Copy link

What are you trying to achieve?

I'm trying to discover whether sharp can crop images. It seems sharp has an extract feature that does what I want, but I can't find formal documentation for it. There's also a crop method, which is also not documented.

Have you searched for similar questions?

Yes. Google shows they exist, but there is no formal documentation for either method.

Are you able to provide a minimal, standalone code sample that demonstrates this question?

N/A

Are you able to provide a sample image that helps explain the question?

N/A

@tomprogers
Copy link
Author

It appears that extract is documented under "resizing," which strikes me as counter-intuitive. I only found that by searching the repo, and then working backward to the web docs.

@lovell
Copy link
Owner

lovell commented Apr 14, 2020

Hi, the docs will hopefully be gaining a search feature soon - please see the upstream issue egoist/docute#261 if you're able to help.

@lovell
Copy link
Owner

lovell commented Apr 15, 2020

Ahead of full support for documentation search, I added some quick, rudimentary keyword-based searching to https://sharp.pixelplumbing.com/ - for example you can now search for the term "crop" and find details for extract().

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants