Merge pull request #1414 from bkonetzny/patch-1

Fixed DateTimeInterface description.
schmittjoh · Apr 21, 2023 · b4e6128 · b4e6128
2 parents b265999 + 0884c70
commit b4e6128
Showing 1 changed file with 22 additions and 14 deletions.
diff --git a/doc/reference/annotations.rst b/doc/reference/annotations.rst
@@ -431,20 +431,28 @@ Available Types:
 |                                                            | string (''). DeserializeFormats can either be a  |
 |                                                            | string or an array of string.                    |
 +------------------------------------------------------------+--------------------------------------------------+
-| DateTimeInterface                                          | PHP's DateTimeImmutable object (default format*/ |
-|                                                            | timezone).                                       |
-+------------------------------------------------------------+--------------------------------------------------+
-| DateTimeInterface<'format'>                                | PHP's DateTimeImmutable object (custom format/   |
-|                                                            | default timezone)                                |
-+------------------------------------------------------------+--------------------------------------------------+
-| DateTimeInterface<'format', 'zone'>                        | PHP's DateTimeImmutable object (custom format/   |
-|                                                            | timezone)                                        |
-+------------------------------------------------------------+--------------------------------------------------+
-| DateTimeInterface<'format', 'zone', 'deserializeFormats'>  | PHP's DateTimeImmutable object (custom format/   |
-|                                                            | timezone/deserialize format). If you do not want |
-|                                                            | to specify a specific timezone, use an empty     |
-|                                                            | string (''). DeserializeFormats can either be a  |
-|                                                            | string or an array of string.                    |
+| DateTimeInterface                                          | PHP's DateTimeInterface interface (default       |
+|                                                            | format*/timezone).                               |
+|                                                            | Data will be always deserialised into            |
+|                                                            | `\DateTime` object                               |
++------------------------------------------------------------+--------------------------------------------------+
+| DateTimeInterface<'format'>                                | PHP's DateTimeInterface interface (custom        |
+|                                                            | format/default timezone)                         |
+|                                                            | Data will be deserialised into                   |
+|                                                            | `\\DateTime` object                              |
++------------------------------------------------------------+--------------------------------------------------+
+| DateTimeInterface<'format', 'zone'>                        | PHP's DateTimeInterface interface (custom        |
+|                                                            | format/timezone)                                 |
+|                                                            | Data will be deserialised into                   |
+|                                                            | `\\DateTime` object                              |
++------------------------------------------------------------+--------------------------------------------------+
+| DateTimeInterface<'format', 'zone', 'deserializeFormats'>  | PHP's DateTimeInterface interface (custom        |
+|                                                            | format/timezone/deserialize format). If you do   |
+|                                                            | not want to specify a specific timezone, use an  |
+|                                                            | empty string (''). DeserializeFormats can either |
+|                                                            | be a string or an array of string.               |
+|                                                            | Data will be deserialised into                   |
+|                                                            | `\\DateTime` object                              |
 +------------------------------------------------------------+--------------------------------------------------+
 | DateInterval                                               | PHP's DateInterval object using ISO 8601 format  |
 +------------------------------------------------------------+--------------------------------------------------+