php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #78258 stream_bucket_new does not have documentation
Submitted: 2019-07-06 08:18 UTC Modified: 2019-07-09 13:05 UTC
Votes:2
Avg. Score:5.0 ± 0.0
Reproduced:2 of 2 (100.0%)
Same Version:1 (50.0%)
Same OS:1 (50.0%)
From: carlosv775 at gmail dot com Assigned:
Status: Verified Package: Streams related
PHP Version: Irrelevant OS: Irrelevant
Private report: No CVE-ID: None
 [2019-07-06 08:18 UTC] carlosv775 at gmail dot com
Description:
------------
---
From manual page: https://php.net/function.stream-bucket-new
---
This page returns FALSE if something goes wrong, for instance, if the stream isn't available. At least the function's signature should be changed to stream_bucket_new ( resource $stream , string $buffer ) : object|bool if no documentation will be written for it.


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2019-07-06 10:53 UTC] requinix@php.net
-Summary: Besides not having a documentation, stream_bucket_new signature is wrong. +Summary: stream_bucket_new does not have documentation -Package: Documentation problem +Package: Streams related
 [2019-07-06 10:53 UTC] requinix@php.net
Returning false or null in case of error is common, and by convention the return value documented with the signature does not include that. Rather, such behavior gets documented in the Return Values section.
 [2019-07-09 13:05 UTC] cmb@php.net
-Status: Open +Status: Verified
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Mon Dec 30 14:01:28 2024 UTC