format.xml: add both class method names or replcate to interface name #3693
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We must either add the names of the methods of both classes — DateTime and DateTimeImmutable, or replace the name of the method of the DateTime::format class with the name of the interface method — DateTimeInterface::format, and the name of the DateTime class with the name of the interface common to these classes — DateTimeInterface. Otherwise, the description of the `u` parameter behaves as if it does not concern the DateTimeImmutable::format() method (although it is assumed that every PHP programmer knows about this; but in reality not everyone knows).
Alternative:
```Microseconds. Note that
<function>date</function> will always generate
<literal>000000</literal> since it takes an <type>int</type>
parameter, whereas <methodname>DateTimeInterface::format</methodname> does
support microseconds if <interfacename>DateTimeInterface</interfacename> was
created with microseconds.```
|
I would go with |
The paragraph describes working with microseconds only through the `DateTime::format` method, which does not include working with microseconds through the `DateTimeImmutable::format` method. In order for the description to affect the methods of these classes, I suggest mentioning the `DateTimeInterface::format` interface method and an object with the DateTimeInterface type: this will show the reader that we are talking about both the DateTime::format method and the DateTimeImmutable::format method
|
I changed the wording. Please check if everything is done correctly ;-) |
cmb69
reviewed
Aug 30, 2024
Wrap the interface name interfacename tag Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
|
Thank you! |
mmalferov
added a commit
to mmalferov/doc-en
that referenced
this pull request
Sep 1, 2024
cmb69
pushed a commit
that referenced
this pull request
Sep 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We must either add the names of the format methods of both classes —
DateTime::formatandDateTimeImmutable::formatand names of the both class names —DateTimeandDateTimeImmutable, or replace the name of the method of theDateTime::formatclass with the name of the interface method —DateTimeInterface::format, and the name of theDateTimeclass with the name of the interface common to these classes —DateTimeInterface.Otherwise, the description of the
uparameter behaves as if it does not concern theDateTimeImmutable::format()method (although it is assumed that every PHP programmer knows about this; but in reality not everyone knows).Alternative: