Doc #78104 [Opn->Csd]: Return section for readgzfile informs about @ operator
| From: | girgias@php.net | Date: | Sat, 08 Jun 2019 15:43:16 +0000 |
| Subject: | Doc #78104 [Opn->Csd]: Return section for readgzfile informs about @ operator | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-16721@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: girgias@php.net
Reported by: girgias@php.net
Summary: Return section for readgzfile informs about @
operator
-Status: Open
+Status: Closed
Type: Documentation Problem
Package: Zlib related
PHP Version: Irrelevant
-Assigned To:
+Assigned To: girgias
Block user comment: N
Private report: N
Previous Comments:
------------------------------------------------------------------------
[2019-06-08 15:41:08] girgias@php.net
Automatic comment from SVN on behalf of girgias
Revision: http://svn.php.net/viewvc/?view=revision&revision=347576
Log: Fix Doc Bug #78104 by removing mentions of @ operator and moving E_WARNING info into
Error/Exception section.
------------------------------------------------------------------------
[2019-06-04 18:58:41] girgias@php.net
Okay, do you want me to fix all the relevant functions by attaching them to this bug report?
Also, it seems like a lot of manual pages use the return section to showcase errors with false
returns.
Does readfile also generate an E_WARNING?
------------------------------------------------------------------------
[2019-06-04 18:45:03] salathe@php.net
> 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().
------------------------------------------------------------------------
[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.
------------------------------------------------------------------------
The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
https://bugs.php.net/bug.php?id=78104
--
Edit this bug report at https://bugs.php.net/bug.php?id=78104&edit=1