Doc #71991 [Nab->Opn]: assert() docs seem to imply PHP 5 only
| From: | requinix@php.net | Date: | Sat, 09 Apr 2016 09:29:04 +0000 |
| Subject: | Doc #71991 [Nab->Opn]: assert() docs seem to imply PHP 5 only | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-13399@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=71991&edit=1
ID: 71991
Updated by: requinix@php.net
Reported by: lsloan at umich dot edu
Summary: assert() docs seem to imply PHP 5 only
-Status: Not a bug
+Status: Open
Type: Documentation Problem
Package: Documentation problem
Operating System: OS X 10.11
PHP Version: 5.6.20
-Assigned To: cmb
+Assigned To:
Block user comment: N
Private report: N
New Comment:
@lsloan is talking about the syntax portion at the top of the description.
> PHP 5
> bool assert ( mixed $assertion [, string $description ] )
> PHP 7
> bool assert ( mixed $assertion [, Throwable $exception ] )
It implies that the
string $description argument is only supported in PHP 5. The patch
changes the first line to "PHP 5 and 7".
Previous Comments:
------------------------------------------------------------------------
[2016-04-09 09:19:23] cmb@php.net
Immediately below the section on the PHP 5 synopsis, there is a
section on the PHP 7 synopsis, which differs slightly.
Additionally, at the very top of the page is the info, that assert
is available under PHP 4, PHP 5 and PHP 7.
------------------------------------------------------------------------
[2016-04-09 00:56:29] requinix@php.net
If you really wanted to, but the online editor is easier. It would help to do the reverse, though:
mention this bug report in your commit. (If you didn't already.)
------------------------------------------------------------------------
[2016-04-09 00:12:36] lsloan at umich dot edu
Thank you for pointing that out. I believe I've finished the job at edit.php.net. My change
now appears under the "Patches for review" heading. Do I need to do anything else, like
attach the patch to this bug report?
------------------------------------------------------------------------
[2016-04-08 23:19:13] requinix@php.net
Changes to the docs online need to be saved, committed to a patch, and finally approved before they
can get onto the site. I see your change but it doesn't look like you've committed it
yet...
------------------------------------------------------------------------
[2016-04-08 16:00:39] lsloan at umich dot edu
Description:
------------
---
From manual page: http://www.php.net/function.assert
---
The manual page includes the text:
Description
PHP 5
bool assert ( mixed $assertion [, string $description ] )
It seems to imply that form of the method is for PHP 5 only. Actually, reading further, it shows
that this form works with PHP 5 and 7. The text should be changed to:
Description
PHP 5 and 7
bool assert ( mixed $assertion [, string $description ] )
I tried to change this via the online documentation editor, but I can't tell whether my change
was saved.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=71991&edit=1