Doc #77064 [NEW]: Return type is contradictory

From: Date: Fri, 26 Oct 2018 06:22:18 +0000
Subject: Doc #77064 [NEW]: Return type is contradictory
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-16099@lists.php.net to get a copy of this message
From:             fabian dot picone at gmail dot com
Operating system: 
PHP version:      Irrelevant
Package:          PHP Language Specification
Bug Type:         Documentation Problem
Bug description:Return type is contradictory

Description:
------------
---
From manual page: https://php.net/datetime.format
---

This doc has something that does not match.

The description of the method is "public string
DateTimeImmutable::format ( string $format )".

But the return value is documented as "Returns the formatted date string
on success or FALSE on failure." .

What is correct now, is the return a string or mixed?

My tests showed up to result in string, could not break it to receive
bool.

So is this internally casted to string? Then you should adapt the return
documentation.



-- 
Edit bug report at https://bugs.php.net/bug.php?id=77064&edit=1
-- 
Try a snapshot (PHP 5.4):   https://bugs.php.net/fix.php?id=77064&r=trysnapshot54
Try a snapshot (PHP 5.5):   https://bugs.php.net/fix.php?id=77064&r=trysnapshot55
Try a snapshot (trunk):     https://bugs.php.net/fix.php?id=77064&r=trysnapshottrunk
Fixed in SVN:               https://bugs.php.net/fix.php?id=77064&r=fixed
Fixed in release:           https://bugs.php.net/fix.php?id=77064&r=alreadyfixed
Need backtrace:             https://bugs.php.net/fix.php?id=77064&r=needtrace
Need Reproduce Script:      https://bugs.php.net/fix.php?id=77064&r=needscript
Try newer version:          https://bugs.php.net/fix.php?id=77064&r=oldversion
Not developer issue:        https://bugs.php.net/fix.php?id=77064&r=support
Expected behavior:          https://bugs.php.net/fix.php?id=77064&r=notwrong
Not enough info:            https://bugs.php.net/fix.php?id=77064&r=notenoughinfo
Submitted twice:            https://bugs.php.net/fix.php?id=77064&r=submittedtwice
register_globals:           https://bugs.php.net/fix.php?id=77064&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=77064&r=php4
Daylight Savings:           https://bugs.php.net/fix.php?id=77064&r=dst
IIS Stability:              https://bugs.php.net/fix.php?id=77064&r=isapi
Install GNU Sed:            https://bugs.php.net/fix.php?id=77064&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=77064&r=float
No Zend Extensions:         https://bugs.php.net/fix.php?id=77064&r=nozend
MySQL Configuration Error:  https://bugs.php.net/fix.php?id=77064&r=mysqlcfg



Thread (3 messages)

« previous php.doc.bugs (#16099) next »