php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #79304 Doc. for DateTime::createFromFormat/date_create_from_format not consistent
Submitted: 2020-02-24 19:57 UTC Modified: 2020-02-25 19:02 UTC
Votes:1
Avg. Score:1.0 ± 0.0
Reproduced:1 of 1 (100.0%)
Same Version:1 (100.0%)
Same OS:1 (100.0%)
From: patrick dot kuijvenhoven at gmail dot com Assigned:
Status: Open Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
Have you experienced this issue?
Rate the importance of this bug to you:

 [2020-02-24 19:57 UTC] patrick dot kuijvenhoven at gmail dot com
Description:
------------
Reference https://www.php.net/manual/en/datetime.createfromformat.php

Please notice where X and Y are present in each column in the following table:

+---------------------+------------------------------+-----------------+
| format              | description                  | example         |
+---------------------+------------------------------+-----------------+
| X and Y             | ...  with (X) or without (Y) | 01 to 31 (X) or |
| (alphabetical sort) |  leading zeros ...           |  1 to 31 (Y)    |
+---------------------+------------------------------+-----------------+

This style works for "d and j", "D and l", "m and n".

The time variants "g and h" and "G and H" do not follow this style. 

This can be fixed by replacing "with or without" to "without or with" in the "description" column for these formats. So, suggested to rewrite as:

+--------------+-------------------------+--------------------------------+
| format       | description             | example                        |
+--------------+-------------------------+--------------------------------+
| g and h      | ... without or with ... | 01 thought 12 or 01 through 12 |
| G and H      | ... without or with ... | 0 thought 23 or 00 through 23  | 
+--------------+-------------------------+--------------------------------+

Another option could be to explicitly mention the format in the description, thus like "... without (G) or with (H) ...".



Patches

createfromformat.patch (last revision 2020-02-24 20:11 UTC by patrick dot kuijvenhoven at gmail dot com)

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2020-02-24 20:11 UTC] patrick dot kuijvenhoven at gmail dot com
The following patch has been added/updated:

Patch Name: createfromformat.patch
Revision:   1582575060
URL:        https://bugs.php.net/patch-display.php?bug=79304&patch=createfromformat.patch&revision=1582575060
 [2020-02-25 00:43 UTC] derick@php.net
This makes it read really weirdly, so I would say "Won't Fix" - if at all, change the examples around.
 [2020-02-25 19:00 UTC] patrick dot kuijvenhoven at gmail dot com
-Summary: Doc. for DateTime::createFromFormat/date_create_from_format not consistent +Summary: patrick.kuijvenhoven@gmail.com
 [2020-02-25 19:00 UTC] patrick dot kuijvenhoven at gmail dot com
I'm not a native English speaker, so I'm not a good judge concerning readability.

In case you prefer keeping the "with or without" and switching the examples around, then, for consistency the "g and h" and "G and H" should by switched as well (to "h and g" and "H and G" to be precise).

Let me know your thoughts. I'd be happy to supply a new patch.
 [2020-02-25 19:02 UTC] patrick dot kuijvenhoven at gmail dot com
-Summary: patrick.kuijvenhoven@gmail.com +Summary: Doc. for DateTime::createFromFormat/date_create_from_format not consistent
 [2020-02-25 19:02 UTC] patrick dot kuijvenhoven at gmail dot com
(Sorry, Summary altered by password manager by accident)
 
PHP Copyright © 2001-2020 The PHP Group
All rights reserved.
Last updated: Fri Oct 30 01:01:23 2020 UTC