Skip to content

docs: update v1 options examples#1407

Open
ishaanlabs-gg wants to merge 1 commit into
jimp-dev:mainfrom
ishaanlabs-gg:fix-docs-v1-options-examples
Open

docs: update v1 options examples#1407
ishaanlabs-gg wants to merge 1 commit into
jimp-dev:mainfrom
ishaanlabs-gg:fix-docs-v1-options-examples

Conversation

@ishaanlabs-gg

Copy link
Copy Markdown

What's Changing and Why

Updates Jimp v1 documentation examples that still showed pre-v1 positional method arguments:

  • flip(true, false) now uses flip({ horizontal: true, vertical: false }).
  • resize(256, 100) and resize(256, 256) examples now use { w, h } options objects.

This matches the current v1 API and addresses the stale docs reported in #1389.

What else might be affected

Documentation/example output only. Runtime code is unchanged.

Tasks

  • Add tests
  • Update Documentation
  • Update jimp.d.ts
  • Add SemVer Label

Validation:

  • git diff --check
  • npx --yes prettier@3.3.3 --check plugins/plugin-flip/src/index.ts packages/jimp/src/index.ts packages/jimp/README.md

Closes #1389

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 error: flip params are wrong

1 participant