php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #41990 imagejpeg 'filename' parameter discription is not clear
Submitted: 2007-07-13 12:11 UTC Modified: 2007-07-27 09:47 UTC
From: mbread at m-bread dot com Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: mbread at m-bread dot com
New email:
PHP Version: OS:

 

 [2007-07-13 12:11 UTC] mbread at m-bread dot com 
Description:
------------
On the documentation page for imagejpeg, it has the following description for the $filename parameter:

--
filename

    The path to the saved file. If not set or NULL, the raw image stream will be outputed directly.

    To skip this argument in order to provide the quality parameter, use NULL. 
--

The sentence "The path to the saved file" sounds as if it is to load a previously-saved image from that path, then display it. From user-submitted notes it appears that it actually saves the image to that file (which would make more sense). In which case it should say "The path to save the file to" or something similar. "Saved" should not be in the past tense.

(Also, my browser spell checker says that "outputed" should be spelt "outputted".)

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2007-07-13 14:45 UTC] tularis@php.net 
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.

Neither outputed nor outputted are correct according to the English grammar rules, it should be called "put out". However, with the popularity of the verb "to output" it seems to be showing up in dictionaries as a correct english word, thus following grammar rules it should indeed be written as "outputted".

I've modified all image-outputting function descriptions to match your suggestion.
 [2007-07-27 09:47 UTC] mgf@php.net 
@tularis: No, your English grammar is faulty. Output has long been a valid verb in the computing world (going back at least 30 years to my personal knowledge), so "put out" could never be a correct formation here.  You are also wrong about "outputted" being correct: since "output" is a compound verb based on "to put", and the past participle of "put" is "put" (not "putted"), the past participle of "output" as used in this sentence, should also be "output".
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Thu Nov 20 07:00:01 2025 UTC