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 #71991 assert() docs seem to imply PHP 5 only
Submitted: 2016-04-08 16:00 UTC Modified: 2016-04-09 11:12 UTC
From: lsloan at umich dot edu Assigned: cmb (profile)
Status: Closed Package: Documentation problem
PHP Version: 5.6.20 OS: OS X 10.11
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If this is not your bug, you can add a comment by following this link.
If this is your bug, but you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: lsloan at umich dot edu
New email:
PHP Version: OS:

 

 [2016-04-08 16:00 UTC] 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.

Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2016-04-08 23:19 UTC] requinix@php.net
-Status: Open +Status: Feedback
 [2016-04-08 23:19 UTC] 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-09 00:12 UTC] lsloan at umich dot edu
-Status: Feedback +Status: Open
 [2016-04-09 00:12 UTC] 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-09 00:56 UTC] 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 09:19 UTC] cmb@php.net
-Status: Open +Status: Not a bug -Assigned To: +Assigned To: cmb
 [2016-04-09 09:19 UTC] 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 09:29 UTC] requinix@php.net
-Status: Not a bug +Status: Open -Assigned To: cmb +Assigned To:
 [2016-04-09 09:29 UTC] requinix@php.net 
@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".
 [2016-04-09 11:10 UTC] cmb@php.net
-Status: Open +Status: Verified -Assigned To: +Assigned To: cmb
 [2016-04-09 11:10 UTC] cmb@php.net 
Oops -- I thought $description isn't supported anymore as of PHP
7.0.0.
 [2016-04-09 11:12 UTC] cmb@php.net 
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=338974
Log: fixed #71991 (assert() docs seem to imply PHP 5 only)

fix contributed by Lance Sloan
 [2016-04-09 11:12 UTC] cmb@php.net
-Status: Verified +Status: Closed
 [2016-04-09 11:12 UTC] cmb@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.
 [2020-02-07 06:07 UTC] phpdocbot@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=6e94da06180a620325949cf09e5e67cc4b1e8684
Log: fixed #71991 (assert() docs seem to imply PHP 5 only)
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Sun Apr 28 21:01:29 2024 UTC