#38020 [Ver->Csd]: getimagesize docs jump around, confusing
| From: | didou@php.net | Date: | Mon, 22 Jan 2007 02:18:52 +0000 |
| Subject: | #38020 [Ver->Csd]: getimagesize docs jump around, confusing | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969374956@lists.php.net to get a copy of this message | ||
ID: 38020
Updated by: didou@php.net
Reported By: cweiss at gmail dot com
-Status: Verified
+Status: Closed
Bug Type: Documentation problem
Operating System: all
PHP Version: Irrelevant
New Comment:
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.
Previous Comments:
------------------------------------------------------------------------
[2006-07-06 14:52:19] 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 :-)
------------------------------------------------------------------------
[2006-07-06 14:36:55] 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.
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/?id=38020&edit=1