php / php/doc-en

Clarify statement about libgd ignoring filters parameter for PNG

Open
#1,582 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Extension: gd good first issue
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

From manual page: https://php.net/function.imagepng

image

Caution: The filters parameter is ignored by system libgd.

You need to explain what the **** that is supposed to mean, and/or link to some other documentation that explains it.

The parameter is "ignored by system libgd". So, is it systematically ignored and completely useless?? Intuition suggests if that was the case the parameter wouldn't exist. So, maybe PHP's GD library can either use "system libgd" (whatever the **** that is), which ignores this parameter, or something else, which does not ignore it. Then I need to know how to figure out whether or not my installation of PHP is using "system libgd".
If that is explained somewhere else, link to it. This sentence, as is and without further explanation, is confusing.

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 imagepng manual page and its caution that the filters parameter is ignored by system libgd. Determine what system libgd means, when the parameter is ignored, and how users can identify that setup; done means the caution is replaced or linked to documentation that answers those questions clearly.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.