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 #38020 getimagesize docs jump around, confusing
Submitted: 2006-07-06 14:36 UTC Modified: 2007-01-22 02:18 UTC
From: cweiss at gmail dot com Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: all
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: cweiss at gmail dot com
New email:
PHP Version: OS:

 

 [2006-07-06 14:36 UTC] cweiss at gmail dot com 
Description:
------------
in the getimagesize manual page, starting with the paragraph just before Example 1 we have:

paragraph about the return array
example 1
paragraph about URL support
example 2
4 more paragraphs about additional elements in the return array

the 2 examples are just long enough to require scrolling to see the other paragraphs, and the URL paragraph changes the subject, so people scanning the docs will initialy think that the 4 elements is all there is to the array.  changing subjects back and forth makes reading tedious.

my suggestion to make this flow better would be to move the URL paragraph and example 2 below example 3 and then of course renumber the examples.

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2006-07-06 14:52 UTC] philip@php.net 
This problem will be solved when the function.getimagesize 
source (in XML/DocBook) is converted to the "new doc style" 
but since ref.image is large this extension might be avoided 
for conversion... for awhile :-)
 [2007-01-22 02:18 UTC] didou@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.


ref.image is converted and the mess in getimagesize() is fixed.
The docs will also include nice graphics for the examples.
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Mon Jul 14 18:01:33 2025 UTC