php / php/doc-extensions

quantizeImage/quantizeImages details incorrect/lacking

Open
#30 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
XML
Stars
2
Forks
6
Avg merge
1d 14h
Merged PRs (30d)
5

Description

From manual page: https://php.net/imagick.quantizeimage


"Imagick::quantizeImage — Analyzes the colors within a reference image"

This isn't correct, nothing is being analyzed, and no analysis is returned. Rather, it reduces the number of colors in the image. Perhaps it does some analysis in order to do so.... This method seems quite finicky, so it's probably worth adding in some actual documentation about what it does.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Imagick::quantizeImage manual entry and locate the corresponding quantizeImage/quantizeImages documentation in this repository. Verify what the methods do, then update the descriptions to explain the color reduction behavior and any relevant finicky details; the documentation is done when it no longer claims that an image is merely analyzed.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.