FAQ
From: lsloan at umich dot edu
Operating system: OS X 10.11
PHP version: 5.6.20
Package: Documentation problem
Bug Type: Documentation Problem
Bug description:assert() docs seem to imply PHP 5 only

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.

Search Discussions

  • Requinix at Apr 8, 2016 at 11:19 pm
    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: Open
    +Status: Feedback
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
      Block user comment: N
      Private report: N

      New Comment:

    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...


    Previous Comments:
    ------------------------------------------------------------------------
    [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.



    ------------------------------------------------------------------------
  • Lsloan at umich dot edu at Apr 9, 2016 at 12:12 am
    Edit report at https://bugs.php.net/bug.php?id=71991&edit=1

      ID: 71991
      User updated by: lsloan at umich dot edu
      Reported by: lsloan at umich dot edu
      Summary: assert() docs seem to imply PHP 5 only
    -Status: Feedback
    +Status: Open
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
      Block user comment: N
      Private report: N

      New Comment:

    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?


    Previous Comments:
    ------------------------------------------------------------------------
    [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.



    ------------------------------------------------------------------------
  • Requinix at Apr 9, 2016 at 12:56 am
    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: Open
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
      Block user comment: N
      Private report: N

      New Comment:

    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.)


    Previous Comments:
    ------------------------------------------------------------------------
    [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.



    ------------------------------------------------------------------------
  • Cmb at Apr 9, 2016 at 9:19 am
    Edit report at https://bugs.php.net/bug.php?id=71991&edit=1

      ID: 71991
      Updated by: cmb@php.net
      Reported by: lsloan at umich dot edu
      Summary: assert() docs seem to imply PHP 5 only
    -Status: Open
    +Status: Not a bug
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
    -Assigned To:
    +Assigned To: cmb
      Block user comment: N
      Private report: N

      New Comment:

    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.


    Previous Comments:
    ------------------------------------------------------------------------
    [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.



    ------------------------------------------------------------------------
  • Requinix at Apr 9, 2016 at 9:29 am
    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.



    ------------------------------------------------------------------------
  • Cmb at Apr 9, 2016 at 11:10 am
    Edit report at https://bugs.php.net/bug.php?id=71991&edit=1

      ID: 71991
      Updated by: cmb@php.net
      Reported by: lsloan at umich dot edu
      Summary: assert() docs seem to imply PHP 5 only
    -Status: Open
    +Status: Verified
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
    -Assigned To:
    +Assigned To: cmb
      Block user comment: N
      Private report: N

      New Comment:

    Oops -- I thought $description isn't supported anymore as of PHP
    7.0.0.


    Previous Comments:
    ------------------------------------------------------------------------
    [2016-04-09 09:29:02] 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 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...

    ------------------------------------------------------------------------


    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=71991
  • Cmb at Apr 9, 2016 at 11:12 am
    Edit report at https://bugs.php.net/bug.php?id=71991&edit=1

      ID: 71991
      Updated by: cmb@php.net
      Reported by: lsloan at umich dot edu
      Summary: assert() docs seem to imply PHP 5 only
    -Status: Verified
    +Status: Closed
      Type: Documentation Problem
      Package: Documentation problem
      Operating System: OS X 10.11
      PHP Version: 5.6.20
      Assigned To: cmb
      Block user comment: N
      Private report: N

      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.




    Previous Comments:
    ------------------------------------------------------------------------
    [2016-04-09 11:12:07] 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:10:00] cmb@php.net

    Oops -- I thought $description isn't supported anymore as of PHP
    7.0.0.

    ------------------------------------------------------------------------
    [2016-04-09 09:29:02] 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 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.)

    ------------------------------------------------------------------------


    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=71991

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupphp-doc-bugs @
categoriesphp
postedApr 8, '16 at 4:00p
activeApr 9, '16 at 11:12a
posts8
users3
websitephp.net

People

Translate

site design / logo © 2019 Grokbase