Doc #78104 [Opn]: Return section for readgzfile informs about @ operator
| From: | salathe@php.net | Date: | Tue, 04 Jun 2019 18:45:03 +0000 |
| Subject: | Doc #78104 [Opn]: Return section for readgzfile informs about @ operator | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-16702@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=78104&edit=1
ID: 78104
Updated by: salathe@php.net
Reported by: girgias@php.net
Summary: Return section for readgzfile informs about @
operator
Status: Open
Type: Documentation Problem
Package: Zlib related
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
> Should it be removed/rewritten?
Yes. It looks like this was copied from the readfile() page. Similar text appears for a small
handful of other functions [1], which should also be tidied up.
Chris is also right in mentioning that errors belong in the "Errors/Exceptions" section.
> Will just need to figure out what kind of error readgzfile produces before being able to update
> its doc page.
Looks like E_WARNING to me.
[1] From a quick search: opendir(), fopen(), readfile(), mysql_connect(), and mysql_pconnect().
Previous Comments:
------------------------------------------------------------------------
[2019-06-04 15:12:42] girgias@php.net
Huh, indeed it is mentioned in fopen, maybe @salathe could chime in as the Editor?
Will just need to figure out what kind of error readgzfile produces before being able to update its
doc page.
------------------------------------------------------------------------
[2019-06-04 14:58:11] daverandom@php.net
The information about the fact that the function may emit an error should be moved to an
Errors/Exceptions section (like e.g. https://www.php.net/manual/en/function.fopen.php)
The mention of the error suppression operator seems a little odd to me, however it is mentioned on
the fopen() page linked above so I'm not actually sure there.
------------------------------------------------------------------------
[2019-06-04 14:53:06] girgias@php.net
Description:
------------
---
From manual page: https://php.net/function.readgzfile
---
The Return value sections say this:
"If an error occurs, FALSE is returned and unless the function was called as @readgzfile, an
error message is printed."
Which seems odd to describe the behavior of the error suppression operator.
Should it be removed/rewritten?
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=78104&edit=1