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

Offen
#25 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
php
Bereich
documentation

Rechercherichtung

Beginne damit, die Handbuchseiten zu Imagick::setColorspace() und Imagick::setImageColorspace() zu vergleichen, lies anschließend die verlinkte Seite zu Imagick::transformImageColorspace() und das zugrunde liegende Verhalten der Erweiterung. Kläre den Unterschied oder dokumentiere ausdrücklich auf beiden Seiten eine Alias-Beziehung und füge Beispiele hinzu, die zeigen, wann jede Methode verwendet werden sollte.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
XML
Sterne
4
Forks
8
Ø Merge
7 Std. 26 Min.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus php/doc-extensions

Alle Issues in php/doc-extensions

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.