php / php/doc-extensions

Clarify the difference between ImageMagick::setColorspace() and ImageMagick::setImageColorspace()

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

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


By reading
https://www.php.net/manual/en/imagick.setcolorspace.php and
https://www.php.net/manual/en/imagick.setimagecolorspace.php

I honestly can't tell the differene between the two, when I should use one and when the other.
There's no example for either of them. (BTW there shoudl ALWAYS be examples, every single page of the documentation should have examples)

The descriptions are slightly different:

public Imagick::setColorspace(int $COLORSPACE): bool
Sets the global colorspace value for the object.

vs

public Imagick::setImageColorspace(int $colorspace): bool
Sets the image colorspace. This method should be used when creating new images. To change the colorspace of an existing image, you should use Imagick::transformImageColorspace().

but it's not clear what the difference is between the "global workspace for the object" and "the image colorspace".

This difference should be clarified in both pages. Or if they are actually the same thing, it should be explicitly stated that one is an alias for the other.

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 by comparing the Imagick::setColorspace() and Imagick::setImageColorspace() manual pages, then read the linked Imagick::transformImageColorspace() page and the underlying extension behavior. Clarify the distinction or explicitly document an alias relationship on both pages, and add examples that show when each method should be used.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.