jimp-dev/jimp

Clarify documentation: callback not required to create an image

Open

#957 opened on Oct 24, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (785 forks)batch import
documentationhelp wantedsolution in issue

Repository metrics

Stars
 (13,218 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The documentation says:

Iyou want to begin with an empty Jimp image, you can call the Jimp constructor passing the width and height of the image to create and a Node-style callback:

 new Jimp(256, 256, (err, image) => {
  // this image is 256 x 256, every pixel is set to 0x00000000
});

However, it works fine to not pass the callback:

const image = new Jimp(256, 256);

Not sure if both options are valid, but it would have made my code simpler from the start if I realised I didn't need the callback.

Contributor guide

Research direction
Update the documentation to indicate that the callback is optional.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85