php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #70890 Invalid "Return values" section for enchant_dict_add_to_session documentaion
Submitted: 2015-11-11 12:36 UTC Modified: 2015-12-17 11:52 UTC
From: justpusher at gmail dot com Assigned: cmb (profile)
Status: Closed Package: Documentation problem
PHP Version: 5.5.30 OS:
Private report: No CVE-ID: None
 [2015-11-11 12:36 UTC] justpusher at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/function.enchant-dict-add-to-session
---
For enchant_dict_add_to_session function, documentation says:

Return Values
Returns TRUE on success or FALSE on failure.

Actually function seems to return no value. This corresponds to description:
void enchant_dict_add_to_session ( resource $dict , string $word )

The translations are wrong, too. 


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2015-11-16 15:39 UTC] marcosptf at yahoo dot com dot br
you are totally right!

recently i wrote a test that don't expect true or false like on doc said, there are waiting null value because this function is a void.

https://github.com/php/php-src/blob/250938e2d35fc54161a18167b7901c5e3b574371/ext/enchant/tests/dict_add_to_session.phpt#L25

congratulations, you saw one thing that many peoples maybe have seen but don't pay attencion!

:D
 [2015-12-17 11:51 UTC] cmb@php.net
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=338284
Log: fixed #70890: Invalid "Return values" section for enchant_dict_add_to_session documentation
 [2015-12-17 11:52 UTC] cmb@php.net
-Status: Open +Status: Closed -Assigned To: +Assigned To: cmb
 [2015-12-17 11:52 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=7c1033f5716d09746f75c1890c02cae89c588f3e
Log: fixed #70890: Invalid "Return values" section for enchant_dict_add_to_session documentation
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Fri Mar 29 14:01:28 2024 UTC