Skip to content

docs: update crop options example#1411

Open
ishaanlabs-gg wants to merge 1 commit into
jimp-dev:mainfrom
ishaanlabs-gg:docs-crop-options-example
Open

docs: update crop options example#1411
ishaanlabs-gg wants to merge 1 commit into
jimp-dev:mainfrom
ishaanlabs-gg:docs-crop-options-example

Conversation

@ishaanlabs-gg

Copy link
Copy Markdown

Summary

  • update the crop JSDoc example to use the current options-object API
  • fix the adjacent wording typo in the crop description

Fixes #972.

Verification

  • rg -n "image\.crop\(150, 100\)|give size" plugins/plugin-crop/src/index.ts returned no matches
  • rg -n "image\.crop\(\{ x: 50, y: 50, w: 150, h: 100 \}\)" plugins/plugin-crop/src/index.ts found the updated example
  • git diff --check

Note: I did not run the full formatter/test suite locally because this checkout has no node_modules, and the current OSC volume is nearly full. pnpm exec prettier --check plugins/plugin-crop/src/index.ts attempted to create a pnpm store under the home Library path before it could run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[documentation] Not enough parameters on crop method

1 participant