jimp-dev/jimp

[documentation] Not enough parameters on crop method

Open

#972 opened on Dec 22, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (13,218 stars) (785 forks)batch import
documentationhelp wantedsolution in issue

Description

(close it if you want bro)

On documentation for croping method : https://github.com/oliver-moran/jimp/tree/master/packages/plugin-crop

Exemple doesn't work : image.crop(150, 150);

It make error :

Error: w and h must be numbers at Jimp.throwError

Just add 2 parametter to make the job :

image.crop(50, 50, 150, 150);

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Update the example in the crop method documentation at https://github.com/oliver moran/jimp/tree/master/packages/plugin crop to show four parameters: image.crop(50, 50, 150, 150);. Ensure the description matches the actual API which requires x, y, w, h.