Doc #66510 [NEW]: Important information missing in docs of DateTimeZone::listAbbreviations

From: Date: Sat, 18 Jan 2014 00:11:08 +0000
Subject: Doc #66510 [NEW]: Important information missing in docs of DateTimeZone::listAbbreviations
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-10850@lists.php.net to get a copy of this message
From:             jonathan at hogervorst dot info
Operating system: 
PHP version:      Irrelevant
Package:          Documentation problem
Bug Type:         Documentation Problem
Bug description:Important information missing in docs of DateTimeZone::listAbbreviations

Description:
------------
---
From manual page: http://www.php.net/datetimezone.listabbreviations
---

Important information about the return value of this function is missing
in the documentation. For example, the fact that historical timezones
are included is very relevant.

The lack of this information results in actually wrong scripts. See for
example this (kind of popular) code (and my comment):
http://stackoverflow.com/a/2839396/251760

I have added a comment to the documentation, trying to explain the
return value of this function and informing people of the 'risks' of
using this function when not considering this:
http://www.php.net/manual/en/datetimezone.listabbreviations.php#114161

Hopefully the documentation can be enhanced :-)


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



Thread (3 messages)

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